lws 9.0.2 → 10.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79de0146785b0838a7841f343e1fd37b602efdb7c6bb566befce04ac32a07281
-  data.tar.gz: 71e2f9a348e48af15bc37f241ddfb3881973361d388754b81a224ffe55da898a
+  metadata.gz: 853db9b24d98b75c7b419c19b8942411b30f74c1e03fae81279a1a4b77228342
+  data.tar.gz: 94afe71cf0b4a1e1c346b4980daf3fcd91059a5ade23db17c5a63a8444603af3
 SHA512:
-  metadata.gz: 5bc54b5ef614447d7d38c363b621a20d6a542eb9966f07e05a9ff09c7f81d196651b3515743f80149088ee35f056060fe59f86a1c63328f136b1bbe0a7c6e494
-  data.tar.gz: 7d0d5414dff5c32164c73d185cf8f3dad902e32dce64dbe0bf35ca5de1bce4a989705986ec8d4f439f171793137d3c1a302d33677c273c2581f39d1fc8ae02bc
+  metadata.gz: d57fd5aa31bef7f4329b62d2d598efa09ca2b6c83bbce691e3952bf1e641129144f527fca41c1e35241feefef51734d56a3230e6110b5e2cddb3101d570a00e7
+  data.tar.gz: 33082b8ba056f64543e91883309752b3978c992b88e2cda39969312c5938d997fb91b18bcc8fcfe7c43ce12dc66bdbf0b9f8e517c57d59d2bababb941451899a

data/CHANGELOG.md

@@ -0,0 +1,573 @@
+# LeftClick Web Services Changelog
+
+All notable changes to this project will be documented in this file.
+
+Up until version 6.1.0, we used the standard Gem version numbering starting at
+version 0.0.1.  From version 6.1.0 on the version will follow the API version
+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/).
+
+## [10.0.0] - 2024-10-10
+
+### Added
+
+- Add vendored caching firmware from the Faraday Middleware project for use
+  with Faraday 2.x
+
+### Changed
+
+- Tighten dependency on `faraday` gem to 1.0; extend support to 2.x (less
+  than 3.0)
+- Rework the `Gemfile`/`gemspec` files; split up runtime and dev dependencies
+
+### Fixed
+
+- Correct the name of the minitest module
+
+## [9.0.2] - 2024-08-12
+
+### Fixed
+
+- Fix crash when creating models that have has-many associations
+
+## [9.0.1] - 2024-06-24
+
+### Add
+
+- Add missing `_ids` attributes for all has-many associations
+
+### Fixed
+
+- Fix dirty model/changes stracking for has-many associations (#12133)
+- Various documentation improvements
+
+### Removed
+
+- Remove all collection item attributes (except for `items`) from the
+  collection model; they don't actually work
+
+## [9.0.0] - 2024-06-19
+
+### Changed
+
+- Further restrict the depency on spyke
+
+## [9.0.0.beta1] - 2024-06-05
+
+### Changed
+
+- Update the dependency on the `spyke` gem
+
+## [8.1.1] - 2023-12-11
+
+### Changed
+
+- Relax the dependency on hashie to allow version 3.5 through 5
+- Update the `leftclick.eu` domain to `leftclick.network`
+- Remove unnecessary test file from the gemspec
+
+## [8.1.0] - 2023-12-11
+
+### Fixed
+
+- Fix all tests (on the LWS side)
+
+### Removed
+
+- Remove the `start_app` attribute from the account model
+
+## [7.5.2] - 2022-05-13
+
+### Changed
+
+- Use safe loading when loading stubs/config YAML (#12134)
+
+### Fixed
+
+- Fix compatibility issue with newer versions of Psych (#12134)
+
+## [7.5.1] - 2022-03-02
+
+### Added
+
+- Add attributes to the customizable model (#12132)
+
+### Changed
+
+- Renamed the `hint_message` attribute to `title` on the customizable model
+
+## [7.5.0] - 2022-01-21
+
+### Added
+
+- Add the `email` attribute to the folder model (#12130)
+- Add the `service_reason` attribute to the player model (#12131)
+
+## [7.4.1] - 2021-10-21
+
+### Changed
+
+- Relax the dependency on the `spyke` gem
+
+## [7.4.0] - 2021-10-21
+
+### Changed
+
+- Relax the dependency on the `net-http-persisent` gem
+
+### Fixed
+
+- Fix missing default documentation for option `http_persistent`
+
+## [7.3.2] - 2021-10-04
+
+### Fixed
+
+- Fix some model URIs (endpoint not in plural form)
+
+## [7.3.1] - 2021-09-29
+
+### Added
+
+- Add the `invite_remarks` and `reservation_required` attributes to the
+  location model (#12127)
+- Add the `layout_kind` attribute to the channel model (#12128)
+- Add the `uuid` attribute to the slide model (#12129)
+
+### Changed
+
+- Update the `status` attribute of the layout version model to allow for
+  the "stage" status (#12128)
+- Updated the copyright, company name and address
+
+## [7.3.0] - 2021-04-22
+
+### Changed
+
+- Start using Rubocop 1.8; add basic To Do config
+
+### Fixed
+
+- Fixed small Rubocop offences
+
+## [7.2.5] - 2021-01-13
+
+### Added
+
+- Add support for HTTP proxy configuration (#12126)
+- Add method `endpoint` on app modules that returns the currently used
+  endpoint (#12096)
+
+### Changed
+
+- Default options in config file are merged into environment-specific
+  configuration
+
+### Fixed
+
+- Documentation tweaks
+
+## [7.2.4] - 2021-01-11
+
+### Added
+
+- Add support for short environment names ("prod" and "dev")
+
+### Changed
+
+- Relax the `faraday_middleware` gem dependency to less than 2.0 (#12118)
+- Use API token (middleware) for Active Storage (#12125)
+
+## [7.2.3] - 2020-12-02
+
+### Added
+
+- Added the "reserved" and "permanent_reserved" status variant for the location
+  model
+- Added the `import_ref` attribute to the location model
+- Added the `definition` attribute to the layout element model
+
+### Changed
+
+- Enabled HTTP caching for LWS Console
+- Switched to Bundler version 2.1
+
+### Fixed
+
+- Fixed small documentation errors and inaccurracies
+
+## [7.2.2] - 2020-11-06
+
+### Changed
+
+- HTTP caching is disable by default; opt-in via config
+- Updated the README to show HTTP caching in an example
+
+## [7.2.1] - 2020-10-29
+
+### Added
+
+- Added HTTP caching using faraday-http-cache gem (#12014)
+
+### Fixed
+
+- Fixed `#dig` on models stumbling over missing methods/attributes
+
+## [7.2.0] - 2020-10-23
+
+### Added
+
+- Added the `address`, `birthdate`, `city`, `country` and `zip_code` attributes
+  to the person model (#12123)
+- Added the `recent_os` attribute to the player model (#12121)
+
+### Fixed
+
+- Fixed storage uploads (almost) always failing (#12124)
+
+## [7.1.4] - 2020-09-17
+
+### Added
+
+- Added the `archive_storage_id` and `archive_url` attributes to the layout
+  version model
+- Added the `company`, `company_id`, `name` and `serial_number` attributes
+  to the reader model (#12113)
+
+### Changed
+
+- Updated the copyright and company address
+
+## [7.1.3] - 2020-09-03
+
+### Added
+
+- Added the `name` and `status_updated_at` attributes to the player model
+- Added the `comments`, `duration`, `edit_account_ids`, `editable_by_me` and
+  `thumbnail_url` attributes to the slide model (#12119)
+- Added the `category_ids`, `company_shared_ids`, `description_html`,
+  `duration_kind`, `public`, `rotation` and `thumbnail_url` attributes to the
+  layout model (#12122)
+
+### Changed
+
+- Renamed the `operation_hours` (from `operational_hours`) and `feedback`
+  (from `feedbacks`) attributes on the player model
+- Renamed the `company_owner` (from `company`) and `company_owner_id`
+  (from `company_id`) atributes on the layout model
+
+### Fixed
+
+- LS Console environment argument now correctly switches to that
+  environment (#12144)
+- Correctly show the debug modes for LWS Console
+- Documentation fixes and improvements
+
+## [7.1.2] - 2020-07-07
+
+### Added
+
+- Added the journal model to the Presence app
+
+### Fixed
+
+- Use fixed model IDs to find models in tests wherever possible
+
+## [7.1.1] - 2020-06-17
+
+### Added
+
+- Added a `deep_dup` method to the generic model
+
+### Fixed
+
+- Documentation fixes and tweaks
+
+## [7.1.0] - 2020-05-11
+
+### Added
+
+- Added the `reset_reason` attribute to the location model (#12121)
+- Added the `checkout_alter_status` and `status` attribute to the location model
+- Added the `location_status_change_permissions` attribute to the person model
+
+### Changed
+
+- Add compatibility with newer Pry versions
+- Changed the `feedbacks` attribute on the player model to a plain hash (#12110)
+
+### Removed
+
+- Removed the player feedback and player feedback result models (#12110)
+
+## [7.0.4] - 2020-03-25
+
+### Fixed
+
+- Decreased minimum test coverage to 95% to work around simplecov issue
+
+## [7.0.3] - 2020-03-25
+
+### Added
+
+- Added `image_storage_id` and `image_url` attributes to the location model (#12117)
+- Added `image_storage_id` and `image_url` attributes to the location map model (#12117)
+- Added `image_storage_id` and `image_url` attributes to the person model (#12117)
+- Added the `Storage` class to the Presence app
+- Added the `Storage.download` helper method
+
+### Deprecated
+
+- Deprecated the `picture_url` on the location map model (#12117)
+- Deprecated the `picture_url` on the person model (#12117)
+- Deprecated the `Generic::Storage.create` helper method in favour of
+  `Generic::Storage.upload`
+
+## [7.0.2] - 2020-03-19
+
+### Added
+
+- Added `processing`, `permission` and `tempory` attributes to the collection
+  model (#12115)
+- Added `status` attribute to the slide model (#12116)
+- Added associations between the slide, channel and channel group models
+- Added a lot of missing attributes to the digital signage models
+
+### Fixed
+
+- Fixed digital signage test queries
+
+## [7.0.1] - 2020-02-20
+
+### Added
+
+- Added `kind` attribute to the layout mode (#12122)
+- Added `hostname` attribute to the player model (#12122)
+
+### Fixed
+
+- Tweaked documentation of the `checkin_status` attribute
+
+## [7.0.0] - 2020-02-03
+
+### Added
+
+- Added `checkin_status` attribute to the location model (#12111)
+- Added `people_responsible_for` attribute to the person model (#12111)
+- Added `person_responsible`, `person_responsible_id` attributes to the person
+  model (#12111)
+
+### Fixed
+
+- Fixed the digital signage test queries for displays
+- Fixed the caching test for newer `faraday_middleware` gem versions
+
+## [6.4.0] - 2020-01-08
+
+### Added
+
+- Added `company_name` attribute to the person model (#11997)
+- Added `time_zone` attribute to the location model (#12109)
+
+### Fixed
+
+- Fixed the layout version model URI
+- Removed duplicate generic attributes from models
+- Fixed some typos in attribute name and order
+
+## [6.3.2] - 2019-09-26
+
+### Added
+
+- Expanded the models and attributes in the presence app (#12108)
+- Added a `#dig` method for the generic/all models
+
+### Fixed
+
+- Fixed the reduced/dropped test coverage (#12107)
+
+## [6.3.1] - 2019-09-05
+
+### Changed
+
+- Reworked the JSON parser to handle metadata better
+- Updated/reworked the Resource app models: added/removed/updated attributes
+  where necessary (#12106)
+
+### Removed
+
+- Removed some attributes that are already part of the generic model from
+  DigitalSignage app models
+
+## [6.3.0] - 2019-09-05
+
+### Added
+
+- Added slide, layout and related models to the DigitalSignage app (#12103)
+- Added the `Storage` class to the DigitalSignage and Resource apps
+
+### Changed
+
+- All non-persisted objects are always saved (even without changes)
+
+### Fixed
+
+- Fixed typos in documentation
+- Fixed some code style issues
+- Default to an empty object if the API provides no data
+
+## v6.2.3
+
+- Move common attributes to the generic model and add `url`/`url_html` (#12004)
+- Add password expiration attributes to the `Company` and `User` model of
+  the Auth app (#12012)
+- Add new attributes to the `Collection` model of the Resource app (#12012)
+
+## v6.2.2.1
+
+- Add missing dependency on net-http-persistent in the gemspec file
+
+## v6.2.2
+
+- Add some more attributes to the Presence app
+- Use persistent HTTP connections from now on (#12101)
+  * Add a configuration option for enabling/disabling persistent HTTP
+    connections
+- Add support for dirtiness checking for all models (#12100)
+  * Only save models using the HTTP if dirty
+
+## v6.2.1
+
+- Add new models and attributes to the Presence app (#12098, #12099)
+- Replace Fixnum by Integer in the documentation (for Ruby ≥ 2.3)
+
+## v6.2.0
+
+- Add the Resource app implementation (#12097)
+- Update the CorporateWebsite app for recent API changes
+
+## v6.1.5
+
+- Update the gemspec to relax the dependency on WebMock to support 2.x and 3.x
+
+## v6.1.4
+
+- Fix LWS Console environment command-line parameter not overriding the config
+- Print LWS setup on LWS Console start
+
+### Apps
+
+- Add some fields to the DigitalSignage app (closes: #12001)
+- Fix some relations in the Auth app (closes: #12026)
+
+## v6.1.3
+
+- Fix `#find` on has many-associations not working
+
+### Development
+
+- Many fixes in the gemspec
+- Use the SpecReporter for tests
+
+## v6.1.2
+
+- Small tweaks to LWS Console
+- Add LWS Console documentation (in the README)
+- Documentation improvements
+
+### Development
+
+- Fix caching tests not tearing down the specific setup
+
+## v6.1.1
+
+- Support a global and user-specific config file for LWS Console
+- Use a separate history and specific prompt for LWS Console
+- Small documentation fixes
+- Speed up the tests
+
+## v6.1.0
+
+- Switch to LWS/LeftClick platform release versions
+- Switch to Spyke as the REST ORM library (closes: #10671)
+- Add some Her backward compatibility support
+- Use JSON as the wire format for sending data to LWS
+- Switch to using our own exceptions (see LWS::Errors)
+- Add support for setting the LWS API token in the environment
+- Switch to Pry as the REPL used by the LWS Console
+- Add commands to the LWS Console to toggle debug options
+- Add option parsing and app/environment/debug mode selection to LWS Console
+
+### Apps
+
+- Add a first implementation of the Digital Signage app (closes: #11110)
+- Update some fields for the Ticket app (closes: #11997)
+- Add the Reader model to the Presence app, add fields to the Location model
+
+### Development
+
+- Reorganize the file structure of the library
+- Add and improve tests and documentation
+- Document and fix model relations throughout all apps
+- Documentation fixes for switch to Spyke
+
+## v0.4.2
+
+- Documentation fixes
+- Obtain full test coverage by adding some tests
+
+## v0.4.1
+
+- Test improvements; use simplecov for coverage metrics.
+
+## v0.4.0
+
+- Add support for the ticket and corporate website app/web service
+- Gem/packaging and documentation fixes
+
+## v0.3.1
+
+- Add a release_if_needed task
+
+…
+
+## v0.0.1
+
+Initial release
+
+[6.3.0]: https://gitlab.leftclick.network/platform/ruby-lws/compare/v6.2.3...v6.3.0
+[6.3.1]: https://gitlab.leftclick.network/platform/ruby-lws/compare/v6.3.0...v6.3.1
+[6.3.2]: https://gitlab.leftclick.network/platform/ruby-lws/compare/v6.3.1...v6.3.2
+[6.4.0]: https://gitlab.leftclick.network/platform/ruby-lws/compare/v6.3.2...v6.4.0
+[7.0.0]: https://gitlab.leftclick.network/platform/ruby-lws/compare/v6.4.0...v7.0.0
+[7.0.1]: https://gitlab.leftclick.network/platform/ruby-lws/compare/v7.0.0...v7.0.1
+[7.0.2]: https://gitlab.leftclick.network/platform/ruby-lws/compare/v7.0.1...v7.0.2
+[7.0.3]: https://gitlab.leftclick.network/platform/ruby-lws/compare/v7.0.2...v7.0.3
+[7.0.4]: https://gitlab.leftclick.network/platform/ruby-lws/compare/v7.0.3...v7.0.4
+[7.1.0]: https://gitlab.leftclick.network/platform/ruby-lws/compare/v7.0.4...v7.1.0
+[7.1.1]: https://gitlab.leftclick.network/platform/ruby-lws/compare/v7.1.0...v7.1.1
+[7.1.2]: https://gitlab.leftclick.network/platform/ruby-lws/compare/v7.1.1...v7.1.2
+[7.1.3]: https://gitlab.leftclick.network/platform/ruby-lws/compare/v7.1.2...v7.1.3
+[7.1.4]: https://gitlab.leftclick.network/platform/ruby-lws/compare/v7.1.3...v7.1.4
+[7.2.0]: https://gitlab.leftclick.network/platform/ruby-lws/compare/v7.1.4...v7.2.0
+[7.2.1]: https://gitlab.leftclick.network/platform/ruby-lws/compare/v7.2.0...v7.2.1
+[7.2.2]: https://gitlab.leftclick.network/platform/ruby-lws/compare/v7.2.1...v7.2.2
+[7.2.3]: https://gitlab.leftclick.network/platform/ruby-lws/compare/v7.2.2...v7.2.3
+[7.2.4]: https://gitlab.leftclick.network/platform/ruby-lws/compare/v7.2.3...v7.2.4
+[7.2.5]: https://gitlab.leftclick.network/platform/ruby-lws/compare/v7.2.4...v7.2.5
+[7.3.0]: https://gitlab.leftclick.network/platform/ruby-lws/compare/v7.2.5...v7.3.0
+[7.3.1]: https://gitlab.leftclick.network/platform/ruby-lws/compare/v7.3.0...v7.3.1
+[7.3.2]: https://gitlab.leftclick.network/platform/ruby-lws/compare/v7.3.1...v7.3.2
+[7.4.0]: https://gitlab.leftclick.network/platform/ruby-lws/compare/v7.3.2...v7.4.0
+[7.4.1]: https://gitlab.leftclick.network/platform/ruby-lws/compare/v7.4.0...v7.4.1
+[7.5.0]: https://gitlab.leftclick.network/platform/ruby-lws/compare/v7.4.1...v7.5.0
+[7.5.1]: https://gitlab.leftclick.network/platform/ruby-lws/compare/v7.5.0...v7.5.1
+[7.5.2]: https://gitlab.leftclick.network/platform/ruby-lws/compare/v7.5.1...v7.5.2
+[8.1.0]: https://gitlab.leftclick.network/platform/ruby-lws/compare/v7.5.2...v8.1.0
+[8.1.1]: https://gitlab.leftclick.network/platform/ruby-lws/compare/v8.1.0...v8.1.1
+[9.0.0.beta1]: https://gitlab.leftclick.network/platform/ruby-lws/compare/v8.1.1...v9.0.0.beta1
+[9.0.0]: https://gitlab.leftclick.network/platform/ruby-lws/compare/v9.0.0.beta1...v9.0.0
+[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

data/README.md

@@ -0,0 +1,170 @@
+# LeftClick Web Services
+
+LWS is a library for Ruby provides access to the LeftClick web
+services/applications using a model-based structure that abstracts from API
+calls using the available REST interfaces.
+
+## Installation
+
+In your Gemfile, add:
+
+```
+gem "lws"
+```
+
+or install the `ruby-lws` package.
+
+
+## Usage
+
+First, you have to initialize the library.  For example, with Rails, you
+would create a new `config/initializers/lws.rb` file with these lines:
+
+```ruby
+# config/initializers/lws.rb
+LWS.setup do |config|
+  config.api_token = "…" # Get it from some place
+end
+```
+
+After that, due to the fact that LWS is based on
+[Spyke](https://github.com/balvig/spyke), you can access the objects in the
+LeftClick Web Services similary to many ActiveRecord-like ORM's:
+
+### Get all map markers of the first map
+
+```ruby
+map = Maps::Map.all.first
+markers = map.markers
+```
+
+### Create an account for company with ID 6
+
+```ruby
+company = Company.find(6)
+account = Auth::Account.create(name: "Foo Bar",
+                               company: company)
+```
+
+### Destroy all locations named "Test"
+
+```ruby
+loc = Presence::Location.where(name: "Test")
+loc.destroy
+```
+
+## Configuration
+
+The following example uses a much more elaborate setup:
+
+```ruby
+LWS.setup do |config|
+  config.api_token_middleware = TokenAuthenticator
+  config.caching_object = MyRedisCache.new
+  config.environment = :development
+  config.endpoints = { maps: "https://maps.leftclick.cloud" }
+  config.http_caching = true
+  config.http_debug = true
+  config.json_debug = true
+  config.logger = Rails.logger
+  config.proxy = "http://proxyserver:8080"
+end
+```
+
+In this setup, a caching object is used that follows the
+`FaradayMiddleWare::Caching` API.  It uses all development API endpoints,
+except for maps, which is overriden to use the production endpoint.  Also
+HTTP request and JSON data debug logging is enabled and LWS will use
+the Rails logger to log the messages. Also HTTP responses will be cached
+in accordance to their ETag/last modification time and the proxy server with
+URL `http://proxyserver:8080` will be used.
+Finally, a custom API token authenticator class is used that should implement
+the `Faraday::Middleware` interface and set the `X-Token` header with the
+runtime determined API token as value, for example:
+
+```ruby
+class TokenAuthenticator < Faraday::Middleware
+
+  def call(env)
+    env[:request_headers]["X-Token"] = … # Some calculated token
+    @app.call(env)
+  end
+
+end
+```
+
+The `LC_LWS_ENV` environment variable is supported to override the LWS
+environment.  Allowed values are "production" (default) and "development".
+The `LC_LWS_API_TOKEN` is supported to set the LWS API token default.
+This only works if a custom API token middleware is not used.
+
+## LWS Console
+
+This library comes with the program `lwsconsole`, which is a command-line
+tool that can be used to interactively use the library.  (This is similar
+to the Rails console.)  See `lwsconsole --help` for the supported
+command-line arguments.
+
+LWS Console will perform the setup for you and give you a prompt in the
+`LWS` module namespace or the module of an app if this is selected via the
+arguments.  It uses the production environment per default using the token
+provided by a command-line argument.  These defaults can be overriden using
+the configuration.  For example, to rename a map:
+
+```console
+$ lwsconsole -t "my_token" -a maps
+[1] lwsconsole(LWS::Maps)> Map.all.map(&:name)
+=> ["Gebouw 1",
+    "Gebouw 3"]
+[2] lwsconsole(LWS::Maps)> map = Map.find(2)
+=> #<LWS::Maps::Map(maps/(:id)) id: 2 name: "Gebouw 3" ... markers: []>
+[3] lwsconsole(LWS::Maps)> map.name = "Gebouw 2"
+"Gebouw 2"
+[4] lwsconsole(LWS::Maps)> map.save
+nil
+```
+
+Besides the API calls, LWS console supports a few commands to change its
+behaviour:
+
+* `http_debug true|false`: Toggles HTTP debugging for API calls
+* `http_debug_headers true|false`: Toggles logging of HTTP headers in the HTTP debug output
+* `json_debug true|false`: Toggles JSON debug output for API calls
+* `reload!`: Reloads all apps
+
+```
+[5] lwsconsole(LWS::Maps)> http_debug true
+true
+```
+
+LWS Console keeps a history of all calls and commands, use the command
+`history --all` to seem them.  Use the command `help` to see all other
+available commands (provided by Pry).
+
+### Configuration files
+
+LWS Console will look for the configuration files first in
+`/etc/LeftClick/lws.yml` and then `~/.config/LeftClick/lws.yml`; they are
+in the YAML format.
+
+The configuration file can set defaults per environment.  It is possible to
+set the API key, endpoints and debug modes.
+
+```yaml
+development:
+  api_token: "my_token"
+  endpoints:
+    maps: "https://maps.leftclick.cloud
+  http_debug: true
+  http_debug_headers: true
+  json_debug: true
+```
+
+To override the default environment or to set default options, use the default section.
+For example:
+
+```yaml
+default:
+  environment: "development"
+  json_debug: true
+```

data/lib/lws/apps/generic.rb

@@ -255,13 +255,15 @@ module LWS::Generic
       # without caching).
       @as_connection = Faraday.new(url: api.url_prefix, proxy: config.proxy) do |c|
         # Request
-        c.request :json
         c.use LWS::Middleware::RequestHeaders, config.api_token
         c.use config.api_token_middleware if config.api_token_middleware.present?
+        c.use LWS::Middleware::JSONEncoder
 
         # Response
-        c.use LWS::JSONLogger, config.logger if config.json_debug
-        c.use LWS::HTTPLogger, config.logger, config.http_debug_headers if config.http_debug
+        c.use LWS::Middleware::JSONLogger, config.logger if config.json_debug
+        if config.http_debug
+          c.use LWS::Middleware::HTTPLogger, config.logger, config.http_debug_headers
+        end
 
         # Adapter
         if config.http_persistent
@@ -271,19 +273,21 @@ module LWS::Generic
         end
       end
 
-      # A plain file connection to LWS (with token autnentication and caching but without
+      # A plain file connection to LWS (with token authentication and caching but without
       # JSON request/response).
       @lws_connection = Faraday.new(url: api.url_prefix, proxy: config.proxy) do |c|
         # Request
         if config.caching_object
-          c.use FaradayMiddleware::Caching, config.caching_object
+          c.use LWS::Middleware::ObjectCaching, config.caching_object
         end
         c.use LWS::Middleware::RequestHeaders, config.api_token
         c.use config.api_token_middleware if config.api_token_middleware.present?
 
         # Response
-        c.use FaradayMiddleware::FollowRedirects, limit: 3
-        c.use LWS::HTTPLogger, config.logger, config.http_debug_headers if config.http_debug
+        c.use LWS::Middleware::FollowRedirects, limit: 3
+        if config.http_debug
+          c.use LWS::Middleware::HTTPLogger, config.logger, config.http_debug_headers
+        end
 
         # Adapter
         if config.http_persistent

data/lib/lws/middleware/caching.rb

@@ -0,0 +1,158 @@
+# Vendored copy from the `faraday-middleware` gem version 1.2.0
+# See also: https://github.com/lostisland/faraday_middleware/blob/main/lib/faraday_middleware/response/caching.rb
+#
+# Copyright (c) 2011 Erik Michaels-Ober, Wynn Netherland, et al.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+# frozen_string_literal: true
+
+require 'faraday'
+require 'forwardable'
+require 'digest/sha1'
+
+# :nocov:
+module LWS::Middleware
+  # Public: Caches GET responses and pulls subsequent ones from the cache.
+  class Caching < Faraday::Middleware
+    attr_reader :cache
+
+    # Internal: List of status codes that can be cached:
+    # * 200 - 'OK'
+    # * 203 - 'Non-Authoritative Information'
+    # * 300 - 'Multiple Choices'
+    # * 301 - 'Moved Permanently'
+    # * 302 - 'Found'
+    # * 404 - 'Not Found'
+    # * 410 - 'Gone'
+    CACHEABLE_STATUS_CODES = [200, 203, 300, 301, 302, 404, 410].freeze
+
+    extend Forwardable
+    def_delegators :'Faraday::Utils', :parse_query, :build_query
+
+    # Public: initialize the middleware.
+    #
+    # cache   - An object that responds to read and write (default: nil).
+    # options - An options Hash (default: {}):
+    #           :ignore_params - String name or Array names of query
+    #                                    params that should be ignored when forming
+    #                                    the cache key (default: []).
+    #           :write_options - Hash of settings that should be passed as the
+    #                                    third options parameter to the cache's #write
+    #                                    method. If not specified, no options parameter
+    #                                    will be passed.
+    #           :full_key      - Boolean - use full URL as cache key:
+    #                                    (url.host + url.request_uri)
+    #           :status_codes  - Array of http status code to be cache
+    #                                    (default: CACHEABLE_STATUS_CODE)
+    #
+    # Yields if no cache is given. The block should return a cache object.
+    def initialize(app, cache = nil, options = {})
+      super(app)
+      if cache.is_a?(Hash) && block_given?
+        options = cache
+        cache = nil
+      end
+      @cache = cache || yield
+      @options = options
+    end
+
+    def call(env)
+      if env[:method] == :get
+        if env[:parallel_manager]
+          # callback mode
+          cache_on_complete(env)
+        else
+          # synchronous mode
+          key = cache_key(env)
+          unless (response = cache.read(key)) && response
+            response = @app.call(env)
+            store_response_in_cache(key, response)
+          end
+          finalize_response(response, env)
+        end
+      else
+        @app.call(env)
+      end
+    end
+
+    def cache_key(env)
+      url = env[:url].dup
+      if url.query && params_to_ignore.any?
+        params = parse_query url.query
+        params.reject! { |k,| params_to_ignore.include? k }
+        url.query = params.any? ? build_query(params) : nil
+      end
+      url.normalize!
+      digest = full_key? ? url.host + url.request_uri : url.request_uri
+      Digest::SHA1.hexdigest(digest)
+    end
+
+    def params_to_ignore
+      @params_to_ignore ||= Array(@options[:ignore_params]).map(&:to_s)
+    end
+
+    def full_key?
+      @full_key ||= @options[:full_key]
+    end
+
+    def custom_status_codes
+      @custom_status_codes ||= begin
+        codes = CACHEABLE_STATUS_CODES & Array(@options[:status_codes]).map(&:to_i)
+        codes.any? ? codes : CACHEABLE_STATUS_CODES
+      end
+    end
+
+    def cache_on_complete(env)
+      key = cache_key(env)
+      if (cached_response = cache.read(key))
+        finalize_response(cached_response, env)
+      else
+        # response.status is nil at this point
+        # any checks need to be done inside on_complete block
+        @app.call(env).on_complete do |response_env|
+          store_response_in_cache(key, response_env.response)
+          response_env
+        end
+      end
+    end
+
+    def store_response_in_cache(key, response)
+      return unless custom_status_codes.include?(response.status)
+
+      if @options[:write_options]
+        cache.write(key, response, @options[:write_options])
+      else
+        cache.write(key, response)
+      end
+    end
+
+    def finalize_response(response, env)
+      response = response.dup if response.frozen?
+      env[:response] = response
+      unless env[:response_headers]
+        env.update response.env
+        # FIXME: omg hax
+        response.instance_variable_set('@env', env)
+      end
+      response
+    end
+  end
+end
+# :nocov:

data/lib/lws/middleware/http_logger.rb

@@ -16,7 +16,9 @@ module LWS
 
     # @private
     # @!visibility private
-    class HTTPLogger < Faraday::Response::Middleware
+    class HTTPLogger <
+      # Use `Faraday::Response::Middleware` if it exists (Faraday < 2.0)
+      defined?(Faraday::Response::Middleware) ? Faraday::Response::Middleware : Faraday::Middleware
 
       def initialize(app, logger, show_headers)
         if logger.nil?
@@ -40,7 +42,6 @@ module LWS
       end
 
       def on_complete(env)
-        super
         @logger.debug "<<< HTTP #{env[:status].to_s}"
         if @show_headers
           env[:response_headers].each do |hdr, val|

data/lib/lws/middleware/json_logger.rb

@@ -16,7 +16,9 @@ module LWS
 
     # @private
     # @!visibility private
-    class JSONLogger < Faraday::Response::Middleware
+    class JSONLogger <
+      # Use `Faraday::Response::Middleware` if it exists (Faraday < 2.0)
+      defined?(Faraday::Response::Middleware) ? Faraday::Response::Middleware : Faraday::Middleware
 
       def initialize(app, logger)
         if logger.nil?

data/lib/lws/middleware/json_parser.rb

@@ -16,7 +16,9 @@ module LWS
 
     # @private
     # @!visibility private
-    class JSONParser < Faraday::Response::Middleware
+    class JSONParser <
+      # Use `Faraday::Response::Middleware` if it exists (Faraday < 2.0)
+      defined?(Faraday::Response::Middleware) ? Faraday::Response::Middleware : Faraday::Middleware
 
       def parse(body)
         json = MultiJson.load(body, symbolize_keys: true)

data/lib/lws/middleware.rb

@@ -19,7 +19,36 @@ module LWS
 
 end
 
+require "lws/middleware/caching"
 require "lws/middleware/http_logger"
 require "lws/middleware/json_logger"
 require "lws/middleware/json_parser"
 require "lws/middleware/request_headers"
+
+# Set up Faraday 1.0/2.0 portability using middleware class aliases.
+module LWS
+  module Middleware
+    FollowRedirects =
+      if defined? Faraday::FollowRedirects::Middleware
+        Faraday::FollowRedirects::Middleware
+      else
+        FaradayMiddleware::FollowRedirects
+      end
+
+    JSONEncoder =
+      if defined? Faraday::Request::Json
+        Faraday::Request::Json
+      else
+        FaradayMiddleware::EncodeJson
+      end
+
+    ObjectCaching =
+      if defined? FaradayMiddleware::Caching
+        FaradayMiddleware::Caching
+      else
+        # Use this vendored middleware implementation because it is not
+        # available for Faraday ≥ 2.0
+        Caching
+      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 = "9.0.2".freeze
+  VERSION = "10.0.0".freeze
 
 end

data/lib/lws.rb

@@ -9,8 +9,16 @@
 # Schootense Dreef 20A, 5708 HZ Helmond, The Netherlands,
 # info@leftclick.eu, +3185-4444-004.
 
-require "faraday_middleware"
+require "faraday"
 require "faraday/http_cache"
+if Gem::Version.new(Faraday::VERSION) < Gem::Version.new("2.0")
+  # For Faraday < 2.0 load deprecated middleware.
+  require "faraday_middleware"
+else
+  # For Faraday ≥ 2.0 load these middleware gems separately.
+  require "faraday/follow_redirects"
+  require "faraday/net_http_persistent"
+end
 require "hashie"
 require "multi_json"
 require "spyke"
@@ -115,7 +123,7 @@ module LWS
     api = Faraday.new(url: api_url, proxy: config.proxy) do |c|
       # Request
       if config.caching_object
-        c.use FaradayMiddleware::Caching, config.caching_object
+        c.use Middleware::ObjectCaching, config.caching_object
       end
       if config.http_caching
         logger = config.http_debug ? config.logger : nil
@@ -125,13 +133,15 @@ module LWS
       end
       c.use RequestHeaders, config.api_token
       c.use config.api_token_middleware if config.api_token_middleware.present?
-      c.request :json
+      c.use Middleware::JSONEncoder
 
       # Response
-      c.use JSONLogger, config.logger if config.json_debug
-      c.use JSONParser
-      c.use FaradayMiddleware::FollowRedirects, limit: 3
-      c.use HTTPLogger, config.logger, config.http_debug_headers if config.http_debug
+      c.use Middleware::JSONLogger, config.logger if config.json_debug
+      c.use Middleware::JSONParser
+      c.use Middleware::FollowRedirects, limit: 3
+      if config.http_debug
+        c.use Middleware::HTTPLogger, config.logger, config.http_debug_headers
+      end
 
       # Adapter
       if config.http_persistent

metadata

@@ -1,15 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: lws
 version: !ruby/object:Gem::Version
-  version: 9.0.2
+  version: 10.0.0
 platform: ruby
 authors:
 - LeftClick B.V.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-12 00:00:00.000000000 Z
+date: 2024-10-10 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: faraday-http-cache
   requirement: !ruby/object:Gem::Requirement
@@ -78,26 +98,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.12'
-- !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: '4.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2.9'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -152,108 +152,10 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.10'
-- !ruby/object:Gem::Dependency
-  name: minitest-reporters
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.3'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.14'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.14'
-- !ruby/object:Gem::Dependency
-  name: simplecov-rcov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
 description: |-
-  This library for Ruby provides access to the LeftClick
-   web services/applications using a model-based structure that abstracts from API calls
-   using the available REST interfaces.
+  This library for Ruby provides access to the LeftClick Web
+    Services and its applications using a model-based structure that abstracts
+    from API calls using the available REST interfaces.
 email:
 - gem@leftclick.eu
 executables:
@@ -261,6 +163,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- README.md
 - bin/lwsconsole
 - lib/lws.rb
 - lib/lws/apps/auth.rb
@@ -274,6 +178,7 @@ files:
 - lib/lws/config.rb
 - lib/lws/errors.rb
 - lib/lws/middleware.rb
+- lib/lws/middleware/caching.rb
 - lib/lws/middleware/http_logger.rb
 - lib/lws/middleware/json_logger.rb
 - lib/lws/middleware/json_parser.rb
@@ -301,5 +206,5 @@ requirements: []
 rubygems_version: 3.3.15
 signing_key:
 specification_version: 4
-summary: LeftClick web services library for Ruby
+summary: LeftClick Web Services library for Ruby
 test_files: []