Add schufa module, DEV-793

Gemfile.lock

@@ -1,8 +1,9 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.2.1.2)
+    activesupport (8.0.1)
       base64
+      benchmark (>= 0.3)
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.3.1)
       connection_pool (>= 2.2.5)
@@ -12,20 +13,23 @@ GEM
       minitest (>= 5.1)
       securerandom (>= 0.3)
       tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
     addressable (2.8.7)
       public_suffix (>= 2.0.2, < 7.0)
     base64 (0.2.0)
-    bigdecimal (3.1.8)
+    benchmark (0.4.0)
+    bigdecimal (3.1.9)
     coffee-script (2.4.1)
       coffee-script-source
       execjs
     coffee-script-source (1.12.2)
     colorator (1.1.0)
-    commonmarker (0.23.10)
+    commonmarker (0.23.11)
     concurrent-ruby (1.3.4)
     connection_pool (2.4.1)
-    csv (3.3.0)
-    dnsruby (1.72.2)
+    csv (3.3.2)
+    dnsruby (1.72.3)
+      base64 (~> 0.2.0)
       simpleidn (~> 0.2.1)
     drb (2.2.1)
     em-websocket (0.5.3)
@@ -35,13 +39,13 @@ GEM
       ffi (>= 1.15.0)
     eventmachine (1.2.7)
     execjs (2.10.0)
-    faraday (2.12.0)
-      faraday-net_http (>= 2.0, < 3.4)
+    faraday (2.12.2)
+      faraday-net_http (>= 2.0, < 3.5)
       json
       logger
-    faraday-net_http (3.3.0)
-      net-http
-    ffi (1.17.0)
+    faraday-net_http (3.4.0)
+      net-http (>= 0.5.0)
+    ffi (1.17.1)
     forwardable-extended (2.6.0)
     gemoji (4.1.0)
     github-pages (232)
@@ -212,7 +216,7 @@ GEM
       gemoji (>= 3, < 5)
       html-pipeline (~> 2.2)
       jekyll (>= 3.0, < 5.0)
-    json (2.7.4)
+    json (2.9.1)
     kramdown (2.4.0)
       rexml
     kramdown-parser-gfm (1.1.0)
@@ -221,17 +225,17 @@ GEM
     listen (3.9.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    logger (1.6.1)
+    logger (1.6.4)
     mercenary (0.3.6)
-    mini_portile2 (2.8.7)
+    mini_portile2 (2.8.8)
     minima (2.5.1)
       jekyll (>= 3.5, < 5.0)
       jekyll-feed (~> 0.9)
       jekyll-seo-tag (~> 2.1)
-    minitest (5.25.1)
-    net-http (0.4.1)
+    minitest (5.25.4)
+    net-http (0.6.0)
       uri
-    nokogiri (1.16.7)
+    nokogiri (1.18.1)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
     octokit (4.25.1)
@@ -244,9 +248,9 @@ GEM
     rb-fsevent (0.11.2)
     rb-inotify (0.11.1)
       ffi (~> 1.0)
-    rexml (3.3.9)
+    rexml (3.4.0)
     rouge (3.30.0)
-    rubyzip (2.3.2)
+    rubyzip (2.4.1)
     safe_yaml (1.0.5)
     sass (3.7.4)
       sass-listen (~> 4.0.0)
@@ -256,7 +260,7 @@ GEM
     sawyer (0.9.2)
       addressable (>= 2.3.5)
       faraday (>= 0.17.3, < 3)
-    securerandom (0.3.1)
+    securerandom (0.4.1)
     simpleidn (0.2.3)
     terminal-table (1.8.0)
       unicode-display_width (~> 1.1, >= 1.1.1)
@@ -265,8 +269,8 @@ GEM
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (1.8.0)
-    uri (0.13.1)
-    webrick (1.8.2)
+    uri (1.0.2)
+    webrick (1.9.1)
 
 PLATFORMS
   ruby
@@ -276,4 +280,4 @@ DEPENDENCIES
   webrick (~> 1.8)
 
 BUNDLED WITH
-   2.5.10
+   2.6.2

README.md

@@ -3,10 +3,13 @@
 https://docs.customgento.com
 
 ## How to Work on this Documentation (these commands do not work with fish, use bash to run them instead)
-1. You need to have Jekyll installed. To install it, follow instructions on https://jekyllrb.com/docs/installation/ubuntu/.
+
+1. You need to have Jekyll installed. To install it, follow instructions
+   on https://jekyllrb.com/docs/installation/ubuntu/.
 2. Clone the repository to your local machine.
-3. Open your terminal and navigate to your project (see instructions on https://idratherbewriting.com/documentation-theme-jekyll/#option2).
-- When you need to update your dependencies run `bundle update`.
-- Otherwise run `bundle install` instead (update would be recommended though).
+3. Open your terminal and navigate to your project (see instructions
+   on https://idratherbewriting.com/documentation-theme-jekyll/#option2).
+    - When you need to update your dependencies run `bundle update`.
+    - Otherwise, run `bundle install` instead (update would be recommended though).
 4. Build the site with `bundle exec jekyll serve`
-5. The site should now run locally at https://localhost:4000/.
+5. The site should now run locally at http://127.0.0.1:4000.

_data/sidebars/home_sidebar.yml

@@ -8,28 +8,24 @@ entries:
   - title: Extensions (Magento 2)
     output: web
     folderitems:
-      - title: ChildProductData
+      - title: Child Product Data
         url: /child-product-data-m2.html
         output: web
-      - title: ConfigurableTierPrices
-        url: /tier-prices-for-configurable-products-m2.html
-        output: web
-      - title: MassUpdateTierPrices
+      - title: Mass Update Tier Prices
         url: /mass-update-tier-prices-m2.html
         output: web
+      - title: SCHUFA Credit Report
+        url: /schufa-credit-report-m2.html
+        output: web
+      - title: Tier Prices For Configurable Products
+        url: /tier-prices-for-configurable-products-m2.html
+        output: web
       - title: PassKey
         url: /passkey-m2.html
         output: web
   - title: Extensions (Magento 1)
     output: web
     folderitems:
-      - title: ConfigurableTierPrices
+      - title: Tier Prices For Configurable Products
         url: /tier-prices-for-configurable-products-m1.html
         output: web
-
-#      - title: ProductBadges (Magento 1)
-#        url: /product-badges-m1.html
-#        output: web
-#      - title: BankIntegration
-#        url: /bank-integration-m1.html
-#        output: web

_data/sidebars/scr_m2_sidebar.yml

@@ -0,0 +1,40 @@
+# This is your sidebar TOC. The sidebar code loops through sections here and provides the appropriate formatting.
+
+entries:
+  - title: Sidebar
+    levels: one
+    folders:
+
+      - title: SchufaCreditReport (M2)
+        output: web
+        folderitems:
+          - title: Description
+            url: "#description"
+            output: web
+          - title: Requirements
+            url: "#requirements"
+            output: web
+          - title: Compatibility
+            url: "#compatibility"
+            output: web
+          - title: Installation Instructions
+            url: "#installation-instructions"
+            output: web
+          - title: Configuration
+            url: "#configuration"
+            output: web
+          - title: How to test?
+            url: "#how-to-test"
+            output: web
+          - title: Uninstallation
+            url: "#uninstallation"
+            output: web
+          - title: Support
+            url: "#support"
+            output: web
+          - title: Licence
+            url: "#licence"
+            output: web
+          - title: Copyright
+            url: "#copyright"
+            output: web

pages/child-product-data-m2.md

@@ -50,8 +50,8 @@ If you do not want to change the data for a specific attribute, you can simply l
 - php: `~7.4.0||~8.1.0||~8.2.0||~8.3.0`
 
 ## Compatibility
-- Hyvä Theme >= `1.0.0`
-- Magento >= `2.4`
+- Magento Open Source / Adobe Commerce >= `2.4`
+- Hyvä Themes >= `1.0.0`
 
 ## Installation Instructions
 The installation procedure highly depends on your setup. In any case, you should use a version control system like git and test the installation on a development system.

pages/mass-update-tier-prices-m2.md

@@ -49,7 +49,7 @@ After the updates have been processed, go back to your product overview, open on
 - magento/module-ui `~101.1`
 
 ## Compatibility
-- Magento >= 2.4
+- Magento Open Source / Adobe Commerce >= 2.4
 
 ## Installation Instructions
 The installation procedure highly depends on your setup. In any case, you should use a version control system like git and test the installation on a development system.

pages/schufa-credit-report-m2.md

@@ -0,0 +1,125 @@
+---
+title: SCHUFA Credit Report (Magento 2)
+permalink: schufa-credit-report-m2.html
+summary: "The SCHUFA Credit Report module for Magento 2 allows you to check the creditworthiness of your customers in order to allow / block certain payment methods."
+sidebar: scr_m2_sidebar
+toc: false
+---
+
+## Description
+
+This module checks the customer's SCHUFA score as soon as a customer tries to place an order with a specific payment
+method. Based on the retrieved score from SCHUFA the extension might block the order placement. If the payment
+method is blocked, the customer will see an error explaining the reason for blocking the payment method. Also, the
+respective payment method will be hidden from this specific customer in future checkouts. For each payment method, the minimum required
+SCHUFA score can be configured in the backend configuration, so you can choose it for each payment method individually.
+
+**The module also works with Hyvä Checkout.**
+
+## Requirements
+
+- ext-curl: `*`,
+- magento/framework `^103.0`
+- magento/module-checkout `^100.4`
+- magento/module-payment `^100.4`
+- PHP `~8.1.0||~8.2.0||~8.3.0`
+
+## Compatibility
+
+- Magento Open Source / Adobe Commerce >= 2.4
+- Luma Checkout
+- Hyvä Checkout >= 1.1.23
+- Interested in other checkout integrations? [Contact us](https://www.customgento.com/){:target="_blank"}!
+
+## Installation Instructions
+
+The installation procedure highly depends on your setup. In any case, you should use a version control system like git
+and test the installation on a development system.
+If you are using Composer (you should!) and downloaded the extension from the Marketplace or have set up your own
+Composer repository, we recommend installing via Composer.
+
+### Composer Installation
+
+1. `composer require customgento/module-schufa-credit-report-m2`
+2. `bin/magento module:enable CustomGento_SchufaCreditReport`
+3. `bin/magento setup:upgrade`
+4. `bin/magento setup:di:compile`
+5. `bin/magento cache:flush`
+
+### Manual Installation
+
+1. Unzip the downloaded files
+2. Create the directory `app/code/CustomGento/SchufaCreditReport/`:
+   `mkdir -p app/code/CustomGento/SchufaCreditReport/`
+3. Copy the unzipped files to the newly created directory `app/code/CustomGento/SchufaCreditReport/`
+4. `bin/magento module:enable CustomGento_SchufaCreditReport`
+5. `bin/magento setup:upgrade`
+6. `bin/magento setup:di:compile`
+7. `bin/magento cache:flush`
+
+## Configuration
+
+You find the settings under Stores > Configuration > Sales > SCHUFA. There are two configuration groups: "General" and
+"Rules". In the "General" group, you can enable the extension and configure the API credentials. In the "Rules" group,
+you can set the score threshold for each payment method.
+
+![Configure General Settings for SCHUFA Credit Report]({{ " images/schufa-credit-report-m2/general-group.png" }} "Configure General Settings for SCHUFA Credit Report")
+
+- **Enabled** Whether the extension should be enabled or not.
+- **Test/Live Mode** If the extension should use the test or live mode. In test mode, the extension will use the test API URL.
+- **Client ID** The SCHUFA client id you get from the SCHUFA support.
+- **Client Certificate** The contents of the client certificate file you get from the SCHUFA support.
+- **Client Key** The content of the client key file you get from the SCHUFA support.
+- **Passphrase** The passphrase for the client key file. This one will also be given by the SCHUFA support.
+
+![Rules configuration for SCHUFA Credit Report module]({{ " images/schufa-credit-report-m2/rules-group.png" }} "Rules configuration for SCHUFA Credit Report module")
+
+- **Minimum Order Value** The module just checks the score if the order value is greater than this value.
+- **Maximum Number Of Failed Credit Reports** The maximum number of failed credit reports before the customer is blocked.
+- **Require Verified Identity** Whether a verified identity of the customer is required. If you enable this setting and the SCHUFA cannot clearly identify the customer, the currently chosen payment method will be blocked.
+- **Payment** Define which payment methods should be checked by the module. You can add as many payment methods as you want. If you do not configure a specific payment method there and someone orders with this payment method, no SCHUFA score will be checked at all.
+  - **Payment Method** The payment method to check.
+  - **Rating Level/ Risk Ratio** The minimum score to allow the payment method. If the rating level is below this threshold, the payment method will be blocked. For example, like you can see in the image above, if a customer chooses Bank Transfer Payment method and his Rating Level is below 75%, the payment method will be blocked. More information about the rating level can be found [here](https://www.schufa.de/en/scoring-data/scoring-schufa/){:target="_blank"}.
+  - **Maximum Order Total** The maximum order total to allow the payment method. If the order total is above this threshold, the payment method will be blocked.
+
+## How to test?
+When you have installed the extension, you can enable test field and then add a sample configuration to the rules section. Then you can try to place an order with the payment method you have configured in the rules section. In the last step of the checkout you will see, if the payment method is blocked or not.
+
+## Troubleshooting - I installed the extension, but it does not work
+
+1. Do you use the latest version of the extension?
+2. Do you use Magento >= 2.4?
+3. Do you really use the correct SCHUFA API credentials?
+4. Are you using the correct certification files?
+5. Make sure to test it in incognito mode or clear the cache.
+6. Make sure that the extension is **not** disabled under Stores > Configuration > Sales > SCHUFA.
+7. Make sure that the SCHUFA Credit Report is enabled in the payment methods configuration.
+
+## Uninstallation
+
+The uninstallation procedure depends on your setup:
+
+### Uninstallation After Composer Installation
+
+1. `bin/magento module:uninstall CustomGento_SchufaCreditReport`
+2. `bin/magento setup:di:compile`
+3. `bin/magento cache:flush`
+
+### Uninstallation After Manual Installation
+
+1. `bin/magento module:disable CustomGento_SchufaCreditReport`
+2. `bin/magento setup:di:compile`
+3. `bin/magento cache:flush`
+4. `rm -r app/code/CustomGento/SchufaCreditReport`
+
+## Support
+
+If you have any issues with this extension, feel free to [contact us](https://www.customgento.com/){:target="_blank"}!
+
+## Licence
+
+[CustomGento Commercial Software Licence](https://www.customgento.com/license){:target="_blank"}
+
+## Copyright
+
+© 2024 - present CustomGento GmbH

pages/tier-prices-for-configurable-products-m2.md

@@ -59,8 +59,7 @@ Given your simple products, which are assigned to configurable products, are als
 - magento/module-store `~101.0`
 
 ## Compatibility
-- Magento Open Source >= 2.3
-- Adobe Commerce >= 2.3
+- Magento Open Source / Adobe Commerce >= 2.3
 
 ## Installation Instructions
 The installation procedure highly depends on your setup. In any case, you should use a version control system like git and test the installation on a development system.