lws 10.0.0 → 11.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 853db9b24d98b75c7b419c19b8942411b30f74c1e03fae81279a1a4b77228342
-  data.tar.gz: 94afe71cf0b4a1e1c346b4980daf3fcd91059a5ade23db17c5a63a8444603af3
+  metadata.gz: f9060d0e061184ea7c8048291d6966629e271070ad3a96a6623e54861cc5f817
+  data.tar.gz: ca0e91888477bc818ec43ab7b8b9b2b44af1444b02abcc4f0b0a08e576663517
 SHA512:
-  metadata.gz: d57fd5aa31bef7f4329b62d2d598efa09ca2b6c83bbce691e3952bf1e641129144f527fca41c1e35241feefef51734d56a3230e6110b5e2cddb3101d570a00e7
-  data.tar.gz: 33082b8ba056f64543e91883309752b3978c992b88e2cda39969312c5938d997fb91b18bcc8fcfe7c43ce12dc66bdbf0b9f8e517c57d59d2bababb941451899a
+  metadata.gz: 364a82c69867855dda2f27187112233b844b0ec2d5533dc5023f6c68aac704f1ed93ce8bc17d01d5ca5e55500bacec3f93008ac54c871f203a474f8e8d09dd92
+  data.tar.gz: dcb07b606e2a2464b0be0acc7afc63f690de9c7e8d953bfa1602f290a1d93901e7a1096024c7fde6ccdfad37bb392e7fa408c8702e702473751335fd47f49971

data/CHANGELOG.md

@@ -8,6 +8,60 @@ of LWS in the major/minor part of te version.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
+## [11.0.0] - 2025-09-30
+
+The biggest change in this release is the complete rework of the API of the
+Resource app. Instead of using subclasses of collection and collection items,
+there is now only a collection and collection item model and each has a
+metadata object attached that is specific to its kind.
+
+### Added
+
+- Add and enable support for retrying a request 3 times
+- Add `LWS::Errors::ServerError` class to indicate LWS server errors
+- Add generic `Metadata` resource class (which is not a REST model)
+- Add `Collection::Metadata`, `Collection::VimeoMetadata`,
+  `Collection::WeatherLocationMetadata` and `YouTubeMetadata` resource
+  subclasses
+- Add `Collection::Item::Metadata`, `Collection::Item::Forecast`,
+  `Collection::Item::ImageMetadata`, `Collection::Item::PDFMetadata`,
+  `Collection::Item::PowerPointMetadata`, `Collection::Item::VideoMetadata`,
+  `Collection::Item::VimeoMetadata` and `Collection::Item::YouTubeMetadata`
+  resource subclasses
+- Add metadata classes for collection and collection item resource models
+
+### Changed
+
+- All error classes are now subclasses of `LWS::Errors::Error`
+- Raise `LWS::Errors::ServerError` when (after retrying) LWS server (still)
+  responds with a HTTP server error (HTTP error codes 500–599)
+- Raise `LWS::Errors::ServerError` when previously a `Spyke::ConnectionError`
+  would have been raised
+- Switch to Rubycop 1.69; update Rubocop todo-items
+
+### Removed
+
+- Remove the `log_object` attribute from the player log model
+- Remove the `Collection::Config`, `Collection::Feed`,
+  `Collection::Feed::Post`, `Collection::Image`, `Collection::Post`,
+  `Collection::Video`, `Collection::Vimeo`, `Collection::WeatherLocation`,
+  `Collection::WeatherLocation::Forefcast` and
+  `Collection::YouTube` resource models
+- Drop support for the config, feed and unknown collection kind
+
+### Fixed
+
+- Set correct version for dependency on `faraday-follow_redirects` gem
+- Decreased minimum test coverage to 90% to work around simplecov issue
+- Documentation fixes
+
+## [10.0.1] - 2024-10-10
+
+### Fixed
+
+- Bring back the dependency on the `net-http-persistent` gem (in case Faraday
+  1.x is used)
+
 ## [10.0.0] - 2024-10-10
 
 ### Added
@@ -571,3 +625,5 @@ Initial release
 [9.0.1]: https://gitlab.leftclick.network/platform/ruby-lws/compare/v9.0.0...v9.0.1
 [9.0.2]: https://gitlab.leftclick.network/platform/ruby-lws/compare/v9.0.1...v9.0.2
 [10.0.0]: https://gitlab.leftclick.network/platform/ruby-lws/compare/v9.0.2...v10.0.0
+[10.0.1]: https://gitlab.leftclick.network/platform/ruby-lws/compare/v10.0.0...v10.0.1
+[11.0.0]: https://gitlab.leftclick.network/platform/ruby-lws/compare/v10.0.1...v11.0.0

data/lib/lws/apps/digital_signage.rb

@@ -1302,10 +1302,6 @@ module LWS::DigitalSignage
     use_api LWS::DigitalSignage.api
     uri "players/:player_id/logs(/:id)"
 
-    # @!attribute log_object
-    #   @return [String] the URL of the player log object
-    attribute :log_object
-
     # @!attribute player
     #   @return [Player] the player the log is produced by
     belongs_to :player, class_name: "LWS::DigitalSignage::Player"

data/lib/lws/apps/generic.rb

@@ -61,6 +61,21 @@ module LWS::Generic
       raise LWS::Errors::ResourceNotFound, msg
     end
 
+    # @private
+    # @!visibility private
+    #
+    # Adds handling exceptions thrown by the raise error Faraday middleware.
+    #
+    # @param [String] method the HTTP method to use for the request
+    # @param [String] path the endpoint path to use for the request
+    # @param [Hash] params the query parameters to use for the request
+    def self.request(method, path, params = {})
+      super
+    rescue Spyke::ConnectionError => exception
+      msg = "connection failed/timed out for #{method.upcase} request on URI #{path}"
+      raise LWS::Errors::ServerError, msg
+    end
+
     # @private
     # @!visibility private
     #

data/lib/lws/apps/resource.rb

@@ -42,10 +42,9 @@ module LWS::Resource
 
   # = The collection class
   #
-  # There are two ways to view collections.  Either it is viewed as a set
-  # of items (see {#items}), or it is viewed as something that is associated
-  # with one or more meta collections that each have specific item objects (see
-  # for example {#feed}, {#image}, {#images}, etc.).
+  # A collection has a specific kind and contains a single or set of items.
+  # For some collection kinds, there is specific metadata (see {#metadata})
+  # available.
   class Collection < LWS::Generic::Model
     use_api LWS::Resource.api
 
@@ -94,16 +93,17 @@ module LWS::Resource
     attribute :item_ids
 
     # @!attribute items
-    #   The returned cllection item (sub)class that is determined by the kind
-    #   of this collection.
-    #
     #   @return [Array<Collection::Item>] the items that are part of the
     #     collection
     has_many :items, class_name: "LWS::Resource::Collection::Item"
 
     # @!attribute kind
-    #   @return ["feed", "feeds", "image", "images", "video", "videos", "weather_location"]
-    #     the name of the class/kind of the collection
+    #   @note
+    #     This library only supports a subset of the available collection/item
+    #     kinds.
+    #   @return ["image", "other", "pdf", "powerpoint", "video", "vimeo",
+    #     "weather_location", "youtube"] the name of the class/kind of the
+    #       collection
     attribute :kind
 
     # @!attribute name
@@ -122,314 +122,449 @@ module LWS::Resource
     # @!attribute uuid
     #   @return [String] the UUID used for unique file name generation
     attribute :uuid
-  end
-
-  # = The collection item class
-  class Collection::Item < LWS::Generic::Model
-    use_api LWS::Resource.api
-    uri "collections/:collection_id/items(/:id)"
 
-    # @!attribute collection
-    #  @return [Collection] the collection that the collection item is a
-    #    part of
-    belongs_to :collection
-
-    # @!attribute collection_id
-    #  @return [Integer] the ID of the collection that the collection item is a
-    #    part of
-    attribute :collection_id
-
-    # @!attribute metadata
-    #   @return [Hash] the metadata of the collection item
-    attribute :metadata
-
-    # @!attribute name
-    #   @return [String] the name of the collection item
-    attribute :name
+    # Returns the metadata of the collection specific to its kind.
+    #
+    # @return [Collection::Metadata] the kind-specific metadata of the collection
+    def metadata
+      case kind
+      # when "feed"
+      #   attrs =
+      #     attributes["metadata"]
+      #       .slice("feed_url", "refresh_interval")
+      #       .symbolize_keys
+      #   FeedMetadata.new(attrs)
+      when "vimeo"
+        attrs = attributes["metadata"]
+          .slice("video_url")
+          .symbolize_keys
+        VimeoMetadata.new(attrs)
+      when "weather_location"
+        attrs =
+          attributes["metadata"]
+            .slice("city", "country", "description", "feed_url",
+              "forecast_interval", "kind", "lat", "link", "long", "name",
+              "refresh_interval", "regio", "title", "token")
+            .symbolize_keys
+        WeatherLocationMetadata.new(attrs)
+      when "youtube"
+        attrs = attributes["metadata"]
+          .slice("video_url")
+          .symbolize_keys
+        YouTubeMetadata.new(attrs)
+      else
+        Metadata.new
+      end
+    end
+  end
 
-    # @!attribute position
-    #   @return [Integer] the position of the item within the collection
-    attribute :position
+  # = The metadata class
+  #
+  # This represents some kind of metadata of a collection/item that is specific to its kind.
+  class Metadata < Hashie::Dash
   end
 
-  # = The collection config class
-  class Collection::Config < Collection::Item
-    use_api LWS::Resource.api
-    uri "collections/:collection_id/configs(/:id)"
+  # = The collection metadata class.
+  #
+  # This represents some kind of metadata of a collection that is specific to its kind.
+  class Collection::Metadata < Metadata
   end
 
-  # = The collection post class
-  class Collection::Post < Collection::Item
-    use_api LWS::Resource.api
+  # = The feed collection metadata class
+  #
+  # This represents the metadata of a feed collection.
+  # class Collection::FeedMetadata < Collection::Metadata
+  #   # @!attribute feed_url
+  #   #   @return [String, nil] the URL of the feed
+  #   property :feed_url
+  #
+  #   # @!attribute refresh_interval
+  #   # @return [Integer] the interval used to refresh feed (in seconds)
+  #   property :refresh_interval
+  # end
 
-    # @!attribute author
-    #   @return [String] the author of the post
-    attribute :author
 
-    # @!attribute avatar
-    #   @return [Hash] the URL information of the avatar image of the post
-    attribute :avatar
+  # = The Vimeo collection metadata class
+  #
+  # This represents the metadata of a Vimeo collection.
+  class Collection::VimeoMetadata < Collection::Metadata
+    # @!attribute video_url
+    #   @return [String, nil] the actual URL of the Vimeo video
+    property :video_url
+  end
 
-    # @!attribute category
-    #   @return [String] the category of the post
-    attribute :category
+  # = The weather location collection metadata class
+  #
+  # This represents the metadata of a weather location collection.
+  class Collection::WeatherLocationMetadata < Collection::Metadata
+    # @!attribute city
+    #   @return [String, nil] the city of the weather location
+    property :city
 
-    # @!attribute comments
-    #   @return [String] the comments of the post
-    attribute :comments
+    # @!attribute country
+    #   @return [String, nil] the country of the weather location
+    property :country
 
     # @!attribute description
-    #   @return [String] the description of the post
-    attribute :description
+    #   @return [String, nil] the description of the weather location
+    property :description
 
-    # @!attribute description
-    #   @return [String] the description of the post
-    attribute :enclosures
+    # @!attribute feed_url
+    #   @return [String, nil] the URL of the feed of the weather location
+    property :feed_url
 
-    # @!attribute guid
-    #   @return [String] the GUID of the post
-    attribute :guid
+    # @!attribute forecast_interval
+    #   @return ["daily", "hourly"] whether the forecast is for a specific day
+    #     or hour
+    property :forecast_interval
 
-    # @!attribute handle
-    #   @return [String] the handle of the post
-    attribute :handle
+    # @!attribute kind
+    #   @return ["open_weather_map", "unknown"] the kind of the weather location
+    property :kind
 
-    # @!attribute link
-    #   @return [String] the link of the post
-    attribute :link
+    # @!attribute lat
+    #   @return [Float, nil] the latitude of the weather location
+    property :lat
 
     # @!attribute link
-    #   @return [String] the timestamp of the modification date of the post
-    attribute :modification_date
+    #   @return [String] the link of the weather location
+    property :link
 
-    # @!attribute order_priority
-    #   @return [Integer] the order priority of the of the post (ascending;
-    #     0 is lowers)
-    attribute :order_priority
+    # @!attribute long
+    #   @return [Float, nil] the longitude of the weather location
+    property :long
 
-    # @!attribute link
-    #   @return [String] the timestamp of the publication date of the post
-    attribute :publication_date
+    # @!attribute name
+    # @return [String] the name of the forecast location
+    property :name
 
-    # @!attribute source_url
-    #   @return [String] the source URL of the post
-    attribute :source_url
+    # @!attribute refresh_interval
+    # @return [Integer] the interval used to refresh the weather location
+    #   (in seconds)
+    property :refresh_interval
 
-    # @!attribute summary
-    #   @return [String] the summary of the post
-    attribute :summary
+    # @!attribute region
+    #   @return [String, nil] the region of the weather location
+    property :region
 
     # @!attribute title
-    #   @return [String] the title of the post
-    attribute :title
-  end
-
-  # = The collection feed class
-  class Collection::Feed < Collection::Item
-    use_api LWS::Resource.api
-    uri "collections/:collection_id/feeds(/:id)"
-
-    # @!attribute feed_url
-    #   @return [String] the URL of the feed
-    attribute :feed_url
-
-    # @!attribute post_ids
-    #   @return [Collection::Post] the IDs of the posts included in the feed
-    attribute :post_ids
-
-    # @!attribute posts
-    #   @return [Collection::Post] the posts included in the feed
-    has_many :posts,
-             class_name: "LWS::Resource::Collection::Feed::Post",
-             uri: "collections/:collection_id/feeds/:feed_id/posts(/:id)"
+    #   @return [String] the title of the weather location
+    property :title
 
-    # @!attribute refresh_interval
-    #   @return [Integer] the interval used to refresh the feed (in seconds)
-    attribute :refresh_interval
+    # @attribute token
+    #  @return [String, nil] the token used to refresh the forecasts
+    property :token
   end
 
-  # = The collection feed post class
-  class Collection::Feed::Post < Collection::Post
-    uri "collections/:collection_id/feeds/:feed_id/posts(/:id)"
-
-    # @!attribute feed
-    #   @return [Collection::Feed] the collection feed that the collection feed
-    #     post is a part of
-    belongs_to :feed,
-               class_name: "LWS::Resource::Collection::Feed",
-               uri: "collections/:collection_id/feeds(/:id)"
-
-    # @!attribute feed_id
-    #   @return [Integer] the ID of the collection feed that the collection
-    #     feed is a post is part of
-    attribute :feed_id
+  # = The YouTube collection metadata class
+  #
+  # This represents the metadata of a YouTube collection.
+  class Collection::YouTubeMetadata < Collection::Metadata
+    # @!attribute video_url
+    #   @return [String, nil] the actual URL of the YouTube video
+    property :video_url
   end
 
-  # = The collection image class
-  class Collection::Image < Collection::Item
+  # = The collection item class
+  #
+  # An item has associated metadata (see {#metadata}) that is specific to the
+  # collection item kind.
+  class Collection::Item < LWS::Generic::Model
     use_api LWS::Resource.api
-    uri "collections/:collection_id/images(/:id)"
 
-    # @!attribute data_url
-    #   @return [String] the URL of the image
-    attribute :data_url
-
-    # @!attribute thumbnail_url
-    #   @return [String] the URL of the thumbnail of the image
-    attribute :thumbnail_url
-  end
+    # @!attribute collection
+    #  @return [Collection] the collection that the collection item is a
+    #    part of
+    belongs_to :collection
 
-  # = The collection video class
-  class Collection::Video < Collection::Item
-    use_api LWS::Resource.api
-    uri "collections/:collection_id/videos(/:id)"
+    # @!attribute collection_id
+    #  @return [Integer] the ID of the collection that the collection item is a
+    #    part of
+    attribute :collection_id
 
     # @!attribute data_url
-    #   @return [String] the URL of the video
+    #   @return [String, nil] the URL of the item (if it has associated data)
     attribute :data_url
 
-    # @!attribute thumbnail_url
-    #   @return [String] the URL of the thumbnail of the video
-    attribute :thumbnail_url
-  end
+    # @!attribute kind
+    #   @note
+    #     This library only supports a subset of the available collection/item
+    #     kinds.
+    #   @return ["forecast", "image", "pdf", "powerpoint", "video", "vimeo",
+    #     "youtube"] the name of the class/kind of the collection item
+    attribute :kind
 
-  # = The collection Vimeo class
-  class Collection::Vimeo < Collection::Item
-    use_api LWS::Resource.api
-    uri "collections/:collection_id/vimeos(/:id)"
+    # @!attribute name
+    #   @return [String] the name of the collection item
+    attribute :name
 
-    # @!attribute data_url
-    #   @return [String] the URL of the vimeo
-    attribute :data_url
+    # @!attribute position
+    #   @return [Integer] the position of the item within the collection
+    attribute :position
 
     # @!attribute thumbnail_url
-    #   @return [String] the URL of the thumbnail of the vimeo
+    #   @return [String, nil] the URL of the thumbnail of the item (if it has
+    #     associated data)
     attribute :thumbnail_url
-  end
-
-  # = The collection YouTube class
-  class Collection::YouTube < Collection::Item
-    use_api LWS::Resource.api
-    uri "collections/:collection_id/youtubes(/:id)"
-
-    # @!attribute data_url
-    #   @return [String] the URL of the youtube
-    attribute :data_url
 
-    # @!attribute thumbnail_url
-    #   @return [String] the URL of the thumbnail of the youtube
-    attribute :thumbnail_url
+    # Returns the metadata of the collection item specific to its kind.
+    #
+    # @return [Collection::Item::Metadata] the kind-specific metadata of the
+    #   collection item
+    def metadata
+      attrs = attributes["metadata"]&.symbolize_keys || {}
+      case kind
+      # when "config"
+      #   ConfigMetadata.new(json: attributes["json"])
+      when "forecast"
+        attrs =
+          attributes
+            .slice("cloudiness", "code", "date", "observation",
+              "precipitation", "temperature", "uv_index", "wind")
+            .symbolize_keys
+        ForecastMetadata.new(attrs)
+      when "image"
+        ImageMetadata.new(attrs)
+      when "pdf"
+        PDFMetadata.new(attrs)
+      # when "post"
+      #   attrs =
+      #     attributes.slice("author", "category", "comments", "description",
+      #       "guid", "handle", "link", "modification_data", "order_priority",
+      #       "publication_date", "source_url", "summary", "title")
+      #   PostMetadata.new(attrs)
+      when "powerpoint"
+        PowerPointMetadata.new(attrs)
+      when "video"
+        VideoMetadata.new(attrs)
+      when "vimeo"
+        VimeoMetadata.new(attrs)
+      when "youtube"
+        YouTubeMetadata.new(attrs)
+      else
+        Metadata.new
+      end
+    end
   end
 
-  # = The collection weather location class
-  class Collection::WeatherLocation < Collection::Item
-    use_api LWS::Resource.api
-    uri "collections/:collection_id/weather_locations(/:id)"
-
-    # @!attribute city
-    #   @return [String] the city of the weather location
-    attribute :city
-
-    # @!attribute country
-    #   @return [String] the country of the weather location
-    attribute :country
-
-    # @!attribute description
-    #   @return [String] the description of the weather location
-    attribute :description
-
-    # @!attribute feed_url
-    #   @return [String] the URL of the feed of the weather location
-    attribute :feed_url
-
-    # @!attribute forecast_ids
-    #   @return [Forecast] the IDs of the forecasts for the weather location
-    attribute :forecast_ids
-
-    # @!attribute forecasts
-    #   @return [Forecast] the forecasts for the weather location
-    has_many :forecasts,
-             class_name: "LWS::Resource::Collection::WeatherLocation::Forecast",
-             uri: "collections/:collection_id/weather_locations/:weather_location_id/forecasts(/:id)"
-
-    # @!attribute kind
-    #   @return ["unknown", "yahoo"] the kind of the weather location
-    attribute :kind
-
-    # @!attribute lat
-    #   @return [Float, nil] the latitude of the weather location
-    attribute :lat
-
-    # @!attribute link
-    #   @return [String] the link of the weather location
-    attribute :link
-
-    # @!attribute long
-    #   @return [Float, nil] the longitude of the weather location
-    attribute :long
-
-    # @!attribute refresh_interval
-    #   @return [Integer] the interval used to refresh the weather location
-    #     (in seconds)
-    attribute :refresh_interval
+  # = The collection item metadata class.
+  #
+  # This represents some kind of metadata of a collection item that is specific
+  # to its collection kind.
+  class Collection::Item::Metadata < Metadata
+  end
 
-    # @!attribute region
-    #   @return [String] the region of the weather location
-    attribute :region
+  # = The config collection item metadata class.
+  #
+  # This represents the metadata of a config item, part of a config collection.
+  # class Collection::Item::ConfigMetadata < Metadata
+  #   # @!attribute json
+  #   #   @return [String] the JSON data of the config
+  #   property :json
+  # end
 
-    # @!attribute title
-    #   @return [String] the title of the weather location
-    attribute :title
-  end
 
-  # = The collection weather location forecast class
-  class Collection::WeatherLocation::Forecast < Collection::Item
-    use_api LWS::Resource.api
-    uri "collections/:collection_id/weather_locations/:weather_location_id/forecasts(/:id)"
+  # = The forecast collection item metadata class
+  #
+  # This represents the metadata of a forecast item, part of a weather location
+  # collection.
+  class Collection::Item::ForecastMetadata < Collection::Item::Metadata
+    # @!attribute cloudiness
+    #   @return [Integer] the percentage of cloud cover for the weather
+    #     location forecast
+    property :cloudiness
 
     # @!attribute code
     #   @return [Integer] the code for the weather location forecast
-    attribute :code
+    property :code
 
     # @!attribute date
     #   @return [Integer] the timestamp of the date of the weather location forecast
-    attribute :date
+    property :date
 
     # @!attribute description
-    #   @return [Integer] the description of the weather location forecast
-    attribute :description
+    #   @return [String] the (English) description of the weather location forecast
+    property :description
 
     # @!attribute observation
     #   @return [Boolean] whether the weather location forecast is a
     #     current observation
-    attribute :observation
+    property :observation
+
+    # @!attribute precipitation
+    #   The precipitation hash contains the propability on precipitation (key
+    #   "probability") between 0 and 1, and the forecasted amount of rain
+    #   (key "rain") and/or snow (key "snow") in millimeter.
+    #   @return [Hash{String=>Float, nil}] the precipitation information of
+    #     the weather location forecast
+    property :precipitation
 
     # @!attribute temperature
     #   The temperature hash contains either the current temperature (key
     #   "now") if the forecast is an observation or the temperature range
     #   (keys "low" and "high") if it is not.
-    #   @return [Hash{String=>Float}] the temperature information of the
+    #
+    #   For hourly forecasts, the value of either key "min" or "max" can have
+    #   the value +true+ based on whether the forecasted temperature for this
+    #   hour is the expected mininum or maximum temperature for the day.
+    #   @return [Hash{String=>Float, Boolean, nil}] the temperature information of the
     #      weather location forecast
-    attribute :temperature
-
-    # @!attribute weather_location
-    #   @return [Collection::WeatherLocation] the collection weather location
-    #     that the collection weather location post is a part of
-    belongs_to :weather_location,
-               class_name: "LWS::Resource::Collection::WeatherLocation",
-               uri: "collections/:collection_id/weather_location(/:id)"
+    property :temperature
 
-    # @!attribute weather_location_id
-    #   @return [Integer] the ID of the collection weather location that the
-    #     collection weather location is a post is part of
-    attribute :weather_location_id
+    # @!attribute uv_index
+    #   @return [Float] the maximum UV index of the weather location forecast
+    property :uv_index
 
     # @!attribute wind
     #   The wind hash contains the wind chill temperature (key "chill"),
     #   direction in degrees (key "direction"), and wind speed (key "speed").
-    #   @return [Hash{String=>Float}] the temperature information of the
+    #   @return [Hash{String=>Float, nil}] the temperature information of the
     #      weather location forecast
-    attribute :wind
+    property :wind
+  end
+
+  # = The image collection item metadata class
+  #
+  # This represents the metadata of an image item, part of an image collection.
+  class Collection::Item::ImageMetadata < Collection::Item::Metadata
+    # @!attribute byte_size
+    #   @return [Integer] the size of the image (in bytes)
+    property :byte_size
+
+    # @!attribute content_type
+    #   @return [String] the MIME content type of the image
+    property :content_type
+
+    # @!attribute filename
+    #   @return [String] the filename of the image
+    property :filename
+
+    # @!attribute height
+    #   @return [Integer] the height of the image (in pixels)
+    property :height
+
+    # @!attribute width
+    #   @return [Integer] the width of the image (in pixels)
+    property :width
+  end
+
+  # = The PDF collection item metadata class
+  #
+  # This represents the metadata of a PDF item, part of a PDF collection.
+  class Collection::Item::PDFMetadata < Collection::Item::ImageMetadata
+  end
+
+  # = The post collection item metadata class
+  #
+  # This represents the metadata of a post item, part of a feed collection.
+  # class Collection::Item::PostMetadata < Collection::Item::Metadata
+  #   # @!attribute author
+  #   #   @return [String] the author of the post
+  #   property :author
+  #
+  #   # @!attribute category
+  #   #   @return [String] the category of the post
+  #   property :category
+  #
+  #   # @!attribute comments
+  #   #   @return [String] the comments of the post
+  #   property :comments
+  #
+  #   # @!attribute description
+  #   #   @return [String] the description of the post
+  #   property :description
+  #
+  #   # @!attribute description
+  #   #   @return [Array<ImageMetadata>] the description of the post
+  #   property :enclosures
+  #
+  #   # @!attribute guid
+  #   #   @return [String] the GUID of the post
+  #   property :guid
+  #
+  #   # @!attribute handle
+  #   #   @return [String] the handle of the post
+  #   property :handle
+  #
+  #   # @!attribute link
+  #   #   @return [String] the link of the post
+  #   property :link
+  #
+  #   # @!attribute link
+  #   #   @return [String] the timestamp of the modification date of the post
+  #   property :modification_date
+  #
+  #   # @!attribute order_priority
+  #   #   @return [Integer] the order priority of the of the post (ascending;
+  #   #     0 is lowers)
+  #   property :order_priority
+  #
+  #   # @!attribute link
+  #   #   @return [String] the timestamp of the publication date of the post
+  #   property :publication_date
+  #
+  #   # @!attribute source_url
+  #   #   @return [String] the source URL of the post
+  #   property :source_url
+  #
+  #   # @!attribute summary
+  #   #   @return [String] the summary of the post
+  #   property :summary
+  #
+  #   # @!attribute title
+  #   #   @return [String] the title of the post
+  #   property :title
+  # end
+
+
+  class Collection::Item::VideoMetadata < Collection::Item::Metadata
+    # @!attribute byte_size
+    #   @return [Integer] the size of the video (in bytes)
+    property :byte_size
+
+    # @!attribute content_type
+    #   @return [String] the MIME content type of the video
+    property :content_type
+
+    # @!attribute display_aspect_ratio
+    #   @return [(Integer, Integer)] the aspect ratio of the video
+    property :display_aspect_ratio
+
+    # @!attribute duration
+    #   @return [Integer] the duration of the video
+    property :duration
+
+    # @!attribute filename
+    #   @return [String] the filename of the video
+    property :filename
+
+    # @!attribute height
+    #   @return [Float] the height of the video (in pixels)
+    property :height
+
+    # @!attribute width
+    #   @return [Float] the width of the video (in pixels)
+    property :width
+  end
+
+  # = The PowerPoint collection item metadata class
+  #
+  # This represents the metadata of a PowerPoint item, part of a PowerPoint
+  # collection.
+  class Collection::Item::PowerPointMetadata < Collection::Item::VideoMetadata
+  end
+
+  # = The Vimeo collection item metadata class
+  #
+  # This represents the metadata of a Vimeo item, part of a Vimeo collection.
+  class Collection::Item::VimeoMetadata < Collection::Item::VideoMetadata
+  end
+
+  # = The YouTube collection item metadata class
+  #
+  # This represents the metadata of a YouTube item, part of a YouTube
+  # collection.
+  class Collection::Item::YouTubeMetadata < Collection::Item::VideoMetadata
   end
 
   # = The folder class

data/lib/lws/errors.rb

@@ -16,17 +16,23 @@ module LWS
   #
   # This module contains the exceptions that can be thrown.
   module Errors
+    # Parent class of all LWS errors.
+    class Error < StandardError; end
+
     # Exception thrown if there are issues with the LWS configuration.
-    class ConfigError < StandardError; end
+    class ConfigError < Error; end
 
     # Exception thrown if an invalid response is returned by LWS.
-    class InvalidResponse < StandardError; end
+    class InvalidResponse < Error; end
 
     # Exception thrown if the resource could not be found in LWS.
-    class ResourceNotFound < StandardError; end
+    class ResourceNotFound < Error; end
+
+    # Exception thrown if the LWS server fails.
+    class ServerError < Error; end
 
     # Exception thrown if there is an issue with the stubbing setup.
-    class StubError < StandardError; end
+    class StubError < Error; end
   end
 
 end

data/lib/lws/middleware/json_parser.rb

@@ -53,7 +53,7 @@ module LWS
       def on_complete(env)
         env[:body] = case env[:status]
                      when 204, 304
-                       parse('{}')
+                       { data: {}, metadata: nil, errors: nil }
                      else
                        parse(env[:body])
                      end

data/lib/lws/middleware/raise_server_error.rb

@@ -0,0 +1,37 @@
+#
+# Copyright © 2016–2021 LeftClick Web Services B.V.
+#
+# This software is property of LeftClick Web Services B.V. and cannot be
+# redistributed and/or modified without permission.  The software or any
+# of its parts cannot be used for any other purposes than the LeftClick
+# services and only during a valid license subscription.  For more
+# information, please contact LeftClick Web Services B.V. at:
+# Schootense Dreef 20A, 5708 HZ Helmond, The Netherlands,
+# info@leftclick.eu, +3185-4444-004.
+
+
+module LWS
+
+  module Middleware
+
+    # @private
+    # @!visibility private
+    class RaiseServerError <
+      # Use `Faraday::Response::Middleware` if it exists (Faraday < 2.0)
+      defined?(Faraday::Response::Middleware) ? Faraday::Response::Middleware : Faraday::Middleware
+
+      def on_complete(env)
+        case env[:status]
+        when 500...600
+          raise LWS::Errors::ServerError, env[:body]
+        when nil
+          raise LWS::Errors::ServerError, "response status missing"
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/lws/middleware.rb

@@ -23,6 +23,7 @@ require "lws/middleware/caching"
 require "lws/middleware/http_logger"
 require "lws/middleware/json_logger"
 require "lws/middleware/json_parser"
+require "lws/middleware/raise_server_error"
 require "lws/middleware/request_headers"
 
 # Set up Faraday 1.0/2.0 portability using middleware class aliases.
@@ -50,5 +51,12 @@ module LWS
         # available for Faraday ≥ 2.0
         Caching
       end
+
+    Retry =
+      if defined? Faraday::Request::Retry
+        Faraday::Request::Retry
+      else
+        Faraday::Retry::Middleware
+      end
   end
 end

data/lib/lws/version.rb

@@ -14,6 +14,6 @@ module LWS
 
   # The LWS library version.
   # @note The major and minor version parts match the LWS API version!
-  VERSION = "10.0.0".freeze
+  VERSION = "11.0.0".freeze
 
 end

data/lib/lws.rb

@@ -18,6 +18,7 @@ else
   # For Faraday ≥ 2.0 load these middleware gems separately.
   require "faraday/follow_redirects"
   require "faraday/net_http_persistent"
+  require "faraday/retry"
 end
 require "hashie"
 require "multi_json"
@@ -138,6 +139,11 @@ module LWS
       # Response
       c.use Middleware::JSONLogger, config.logger if config.json_debug
       c.use Middleware::JSONParser
+      c.use Middleware::RaiseServerError
+      c.use Middleware::Retry, exceptions: Middleware::Retry::DEFAULT_EXCEPTIONS +
+                                           [Errno::EALREADY, Faraday::ConnectionFailed],
+                               interval: 0.2,
+                               retry_statuses: [502, 503, 504]
       c.use Middleware::FollowRedirects, limit: 3
       if config.http_debug
         c.use Middleware::HTTPLogger, config.logger, config.http_debug_headers

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lws
 version: !ruby/object:Gem::Version
-  version: 10.0.0
+  version: 11.0.0
 platform: ruby
 authors:
 - LeftClick B.V.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-10 00:00:00.000000000 Z
+date: 2025-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -64,6 +64,26 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: net-http-persistent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
@@ -182,6 +202,7 @@ files:
 - lib/lws/middleware/http_logger.rb
 - lib/lws/middleware/json_logger.rb
 - lib/lws/middleware/json_parser.rb
+- lib/lws/middleware/raise_server_error.rb
 - lib/lws/middleware/request_headers.rb
 - lib/lws/stubbing.rb
 - lib/lws/version.rb