Update Ruby deps for v3.3

.travis.yml

@@ -1,7 +1,8 @@
 sudo: false
 language: ruby
+dist: focal  # Ubuntu 20.04
 rvm:
-  - 2.7.7
+  - 3.3.0
 cache: bundler
 env:
   global:

Gemfile

@@ -1,11 +1,11 @@
-ruby '>=2.3.1'
+ruby '>=3.2.5'
 source 'https://rubygems.org'
 
 # Middleman
-gem 'middleman', '~>4.2.1'
-gem 'middleman-syntax', '~> 3.0.0'
-gem 'middleman-autoprefixer', '~> 2.7.0'
-gem "middleman-sprockets", "~> 4.1.0"
-gem 'rouge', '~> 2.0.5'
-gem 'redcarpet', '~> 3.4.0'
-gem 'nokogiri', '~> 1.8.2'
+gem 'middleman', '~> 4.5.1'
+gem 'middleman-syntax', '~> 3.4.0'
+gem 'middleman-autoprefixer', '~> 3.0.0'
+gem 'middleman-sprockets', '~> 4.1.1'
+gem 'rouge', '~> 3.2.0'
+gem 'redcarpet', '~> 3.6.0'
+gem 'nokogiri', '~> 1.16.7'

Gemfile.lock

@@ -1,130 +1,167 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.0.6)
+    activesupport (7.0.8.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (~> 0.7)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
-    autoprefixer-rails (6.7.7.2)
-      execjs
-    backports (3.11.1)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
+    autoprefixer-rails (10.4.19.0)
+      execjs (~> 2)
+    backports (3.25.0)
     coffee-script (2.4.1)
       coffee-script-source
       execjs
     coffee-script-source (1.12.2)
-    compass-import-once (1.0.5)
-      sass (>= 3.2, < 3.5)
-    concurrent-ruby (1.0.5)
-    contracts (0.13.0)
-    dotenv (2.2.1)
+    concurrent-ruby (1.3.4)
+    contracts (0.16.1)
+    dotenv (3.1.2)
     erubis (2.7.0)
-    execjs (2.7.0)
-    fast_blank (1.0.0)
-    fastimage (2.1.1)
-    ffi (1.9.18)
-    haml (5.0.4)
-      temple (>= 0.8.0)
+    execjs (2.9.1)
+    fast_blank (1.0.1)
+    fastimage (2.3.1)
+    ffi (1.17.0-aarch64-linux-gnu)
+    ffi (1.17.0-aarch64-linux-musl)
+    ffi (1.17.0-arm-linux-gnu)
+    ffi (1.17.0-arm-linux-musl)
+    ffi (1.17.0-arm64-darwin)
+    ffi (1.17.0-x86-linux-gnu)
+    ffi (1.17.0-x86-linux-musl)
+    ffi (1.17.0-x86_64-darwin)
+    ffi (1.17.0-x86_64-linux-gnu)
+    ffi (1.17.0-x86_64-linux-musl)
+    haml (6.3.0)
+      temple (>= 0.8.2)
+      thor
       tilt
     hamster (3.0.0)
       concurrent-ruby (~> 1.0)
-    hashie (3.5.7)
-    i18n (0.7.0)
-    kramdown (1.16.2)
-    listen (3.0.8)
-      rb-fsevent (~> 0.9, >= 0.9.4)
-      rb-inotify (~> 0.9, >= 0.9.7)
-    memoist (0.16.0)
-    middleman (4.2.1)
+    hashie (3.6.0)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    kramdown (2.4.0)
+      rexml
+    listen (3.9.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    memoist (0.16.2)
+    middleman (4.5.1)
       coffee-script (~> 2.2)
-      compass-import-once (= 1.0.5)
       haml (>= 4.0.5)
-      kramdown (~> 1.2)
-      middleman-cli (= 4.2.1)
-      middleman-core (= 4.2.1)
-      sass (>= 3.4.0, < 4.0)
-    middleman-autoprefixer (2.7.1)
-      autoprefixer-rails (>= 6.5.2, < 7.0.0)
-      middleman-core (>= 3.3.3)
-    middleman-cli (4.2.1)
-      thor (>= 0.17.0, < 2.0)
-    middleman-core (4.2.1)
-      activesupport (>= 4.2, < 5.1)
-      addressable (~> 2.3)
+      kramdown (>= 2.3.0)
+      middleman-cli (= 4.5.1)
+      middleman-core (= 4.5.1)
+    middleman-autoprefixer (3.0.0)
+      autoprefixer-rails (~> 10.0)
+      middleman-core (>= 4.0.0)
+    middleman-cli (4.5.1)
+      thor (>= 0.17.0, < 1.3.0)
+    middleman-core (4.5.1)
+      activesupport (>= 6.1, < 7.1)
+      addressable (~> 2.4)
       backports (~> 3.6)
-      bundler (~> 1.1)
-      contracts (~> 0.13.0)
+      bundler (~> 2.0)
+      contracts (~> 0.13, < 0.17)
       dotenv
       erubis
       execjs (~> 2.0)
       fast_blank
       fastimage (~> 2.0)
       hamster (~> 3.0)
       hashie (~> 3.4)
-      i18n (~> 0.7.0)
-      listen (~> 3.0.0)
+      i18n (~> 1.6.0)
+      listen (~> 3.0)
       memoist (~> 0.14)
-      padrino-helpers (~> 0.13.0)
+      padrino-helpers (~> 0.15.0)
       parallel
       rack (>= 1.4.5, < 3)
-      sass (>= 3.4)
+      sassc (~> 2.0)
       servolux
-      tilt (~> 2.0)
+      tilt (~> 2.0.9)
+      toml
       uglifier (~> 3.0)
+      webrick
     middleman-sprockets (4.1.1)
       middleman-core (~> 4.0)
       sprockets (>= 3.0)
-    middleman-syntax (3.0.0)
+    middleman-syntax (3.4.0)
       middleman-core (>= 3.2)
-      rouge (~> 2.0)
-    mini_portile2 (2.3.0)
-    minitest (5.11.3)
-    nokogiri (1.8.2)
-      mini_portile2 (~> 2.3.0)
-    padrino-helpers (0.13.3.4)
-      i18n (~> 0.6, >= 0.6.7)
-      padrino-support (= 0.13.3.4)
+      rouge (~> 3.2)
+    minitest (5.25.1)
+    nokogiri (1.16.7-aarch64-linux)
+      racc (~> 1.4)
+    nokogiri (1.16.7-arm-linux)
+      racc (~> 1.4)
+    nokogiri (1.16.7-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.16.7-x86-linux)
+      racc (~> 1.4)
+    nokogiri (1.16.7-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.16.7-x86_64-linux)
+      racc (~> 1.4)
+    padrino-helpers (0.15.3)
+      i18n (>= 0.6.7, < 2)
+      padrino-support (= 0.15.3)
       tilt (>= 1.4.1, < 3)
-    padrino-support (0.13.3.4)
-      activesupport (>= 3.1)
-    parallel (1.12.1)
-    public_suffix (3.0.1)
-    rack (2.0.4)
-    rb-fsevent (0.10.2)
-    rb-inotify (0.9.10)
-      ffi (>= 0.5.0, < 2)
-    redcarpet (3.4.0)
-    rouge (2.0.7)
-    sass (3.4.25)
+    padrino-support (0.15.3)
+    parallel (1.26.3)
+    parslet (2.0.0)
+    public_suffix (6.0.1)
+    racc (1.8.1)
+    rack (2.2.9)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.11.1)
+      ffi (~> 1.0)
+    redcarpet (3.6.0)
+    rexml (3.3.7)
+    rouge (3.2.1)
+    sassc (2.4.0)
+      ffi (~> 1.9)
     servolux (0.13.0)
-    sprockets (3.7.1)
+    sprockets (4.2.1)
+      concurrent-ruby (~> 1.0)
+      rack (>= 2.2.4, < 4)
+    temple (0.10.3)
+    thor (1.2.2)
+    tilt (2.0.11)
+    toml (0.3.0)
+      parslet (>= 1.8.0, < 3.0.0)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-      rack (> 1, < 3)
-    temple (0.8.0)
-    thor (0.20.0)
-    thread_safe (0.3.6)
-    tilt (2.0.8)
-    tzinfo (1.2.4)
-      thread_safe (~> 0.1)
     uglifier (3.2.0)
       execjs (>= 0.3.0, < 3)
+    webrick (1.8.1)
 
 PLATFORMS
-  ruby
+  aarch64-linux
+  aarch64-linux-gnu
+  aarch64-linux-musl
+  arm-linux
+  arm-linux-gnu
+  arm-linux-musl
+  arm64-darwin
+  x86-linux
+  x86-linux-gnu
+  x86-linux-musl
+  x86_64-darwin
+  x86_64-linux
+  x86_64-linux-gnu
+  x86_64-linux-musl
 
 DEPENDENCIES
-  middleman (~> 4.2.1)
-  middleman-autoprefixer (~> 2.7.0)
-  middleman-sprockets (~> 4.1.0)
-  middleman-syntax (~> 3.0.0)
-  nokogiri (~> 1.8.2)
-  redcarpet (~> 3.4.0)
-  rouge (~> 2.0.5)
+  middleman (~> 4.5.1)
+  middleman-autoprefixer (~> 3.0.0)
+  middleman-sprockets (~> 4.1.1)
+  middleman-syntax (~> 3.4.0)
+  nokogiri (~> 1.16.7)
+  redcarpet (~> 3.6.0)
+  rouge (~> 3.2.0)
 
 RUBY VERSION
-   ruby 2.4.2p198
+   ruby 3.3.0p0
 
 BUNDLED WITH
-   1.16.1
+   2.5.3

README.md

@@ -7,12 +7,30 @@ https://docs.opendatasoft.com/api/
 
 ## Building the documentation
 
+You must install [Ruby](https://www.ruby-lang.org/en/) to build this documentation. Note that on MacOS, you can find a
+Ruby v2.6 installed with the OS. As you can read on this following page [Ruby Branches
+Maintenance](https://www.ruby-lang.org/en/downloads/branches/), that the 2.6 version is quite obsolete and unmaintained.
+
+### Ruby Install
+
+You can use the [rbenv](https://github.com/rbenv/rbenv) tool which, as the pyenv tool, helps you to install any version
+of Ruby. You can just do `brew install rbenv`. Make sure you also have these packages `openssl@3 readline libyaml gmp`
+necessary to build Ruby on your laptop.
+
+Then:
+
+* `rbenv install -l` to see the latest stable versions of Ruby
+* `rbenv install 3.3.0` or any `3.3.x` version.
+
+You might need to add `eval "$(rbenv init - zsh)"` to your `.zshrc` file. If you use Bash, change and use zsh :)
+
 ### Prerequisites
 
 You will need bundler to build the documentation.
 
 ```shell
-bundle install --path vendor/bundle
+bundle config set path 'vendor/bundle'
+bundle install
 ```
 
 ### Development server
@@ -23,7 +41,7 @@ To run the development server
 bundle exec middleman server
 ```
 
-You can now see the docs at http://localhost:4567.
+You can now see the docs at http://localhost:4567. As you don't have a `index.html` file, you have to update the URL adding `/wfs-v2.html` for instance to check out the content related to WFS v2.
 
 ### Build
 
@@ -33,9 +51,9 @@ bundle exec middleman build
 
 ### Deploy
 
-The `develop` branch is automatically deployed to https://help.opendatasoft.com/en/apis
+The `develop` branch is automatically deployed to https://betahelp.opendatasoft.com/en/apis
 
-The `master` branch is automatically deployed to https://betahelp.opendatasoft.com/en/apis
+The `master` branch is automatically deployed to https://help.opendatasoft.com/en/apis
 
 ## Writing rules
 

config.rb

@@ -1,7 +1,7 @@
 # Unique header generation
 require './lib/unique_head.rb'
 
-["ods-search-v1", "wfs", "csw", "tpf", "odata"].each do |apis|
+["ods-search-v1", "wfs-v1", "wfs-v2", "csw", "tpf", "odata"].each do |apis|
   proxy "/#{apis}/index.html", "#{apis}.html", :locals => { :page_apis => apis }
 end
 
@@ -29,7 +29,13 @@
   require './lib/multilang.rb'
 end
 
-activate :sprockets
+# sprockets should not be used to compile '.css.scss' files since middleman v4 does it.
+# When sprockets tries to compile some (already compiled) .css as .scss files, it fails.
+# just use sprockets to bundle the Javascript files.
+# see https://github.com/middleman/middleman-sprockets/issues/127#issuecomment-736958140
+activate :sprockets do |sprockets|
+  sprockets.supported_output_extensions = ['.js']
+end
 
 activate :autoprefixer do |config|
   config.browsers = ['last 2 version', 'Firefox ESR']

source/includes/v1/available_apis.md

@@ -1,5 +1,10 @@
 # Search API v1
 
+<aside style="border: 1px solid rgba(239, 183, 27, 0.4);background: rgba(239, 183, 27, 0.1);">
+This API is deprecated: it is still supported but you should not start a new project or a new integration with it.
+You should use <a href="https://help.opendatasoft.com/apis/ods-explore-v2/">Opendatasoft Explore API V2</a> instead.
+</aside>
+
 Opendatasoft datasets are accessible by developers through an HTTP REST API.
 
 The domain <https://documentation-resources.opendatasoft.com> is used to illustrate examples in the following documentation.

source/includes/wfs/describe_feature_type.md → source/includes/wfs-v1/describe_feature_type.md

@@ -35,4 +35,4 @@ The existing parameters in the WFS standard that are not listed in this table ar
 
 Parameter | Description | Optionality and use
 --------- | ----------- | -------------------
-`TypeName` | A comma-separated list of feature types to describe. | Optional. When omitted, return all feature types known.
+`TypeName` | A comma-separated list of feature types to describe. | Optional. When omitted, return all feature types known.

source/includes/wfs/get_capabilities.md → source/includes/wfs-v1/get_capabilities.md

@@ -54,4 +54,4 @@ Section name | Content
 `ServiceIdentification` | Metadata about the WFS implementation
 `ServiceProvider` | Metadata about the organization offering the WFS service
 `OperationsMetadata` | Metadata about the WFS operations offered by the WFS implementation
-`FeatureTypeList` | List of features types that are available from the service
+`FeatureTypeList` | List of features types that are available from the service

source/includes/wfs/get_feature.md → source/includes/wfs-v1/get_feature.md

@@ -44,4 +44,4 @@ Parameter | Description | Optionality and use
 `maxFeatures` | Used to define the maximum number of records that should be returned from the result set of a query | Optional. Value must be a positive integer
 `TypeName` | A list of feature type names to query | Mandatory
 `PropertyName` | A list of properties that should be returned | Optional. The absence of a value also indicates that all properties should be fetched
-`featureId` | An enumerated list of feature instances to fetch identified by their feature identifiers | Optional
+`featureId` | An enumerated list of feature instances to fetch identified by their feature identifiers | Optional

source/includes/wfs/introduction.md → source/includes/wfs-v1/introduction.md

@@ -70,4 +70,4 @@ Name | Definition | Data type and value | Multiplicity and use
 ---- | ---------- | ------------------- | --------------------
 `ExceptionText` | Text describing specific exception represented by the exceptionCode | Character String type, not empty. Value is an exception description as defined by individual servers | Zero or more (optional). Omitted only when no more useful information available
 `exceptionCode` | Code representing type of this exception | Character String type, not empty. Allowed values are specified by each implementation specification and server <br> implementation | One (mandatory)
-`locator` | Indicator of location in the client's operation request where this exception was encountered | Character String type, not empty Contents defined for each allowed exceptionCode value for each operation | Zero or one (optional). Omitted when no useful value available
+`locator` | Indicator of location in the client's operation request where this exception was encountered | Character String type, not empty Contents defined for each allowed exceptionCode value for each operation | Zero or one (optional). Omitted when no useful value available