lws 7.0.2 → 7.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2baebac6cb99dc5b7106f8cb9eeff4953f623ed1c7a2465ef165e9bf48c0330a
-  data.tar.gz: 58833b0704e57635dcf70f06391f45276723efadac02ed05106efb23ce82f70d
+  metadata.gz: b61e005e4e0e7bf19e2d9299e5444e914c5aac6df6cfd3084cd63ff5fd75bb87
+  data.tar.gz: 0fa6b75fa04c5b9823052e79a74283fcb1de031ca3312cd921f942100cb32248
 SHA512:
-  metadata.gz: 1430d0b1e0927121be013e60191be69e41b3fcc8a388ac6f707d6c39471fcf540776cf82c674f50104fa200e0c43f28f7c6662b3e1787116205e8b5f04357d51
-  data.tar.gz: 98e60f674fc4b39ab09805accb562f6080c87573930dff4c660f42b8ef0c806c44460fdc191aa6bad86636374cc7619cedbb84ae90fbfdcab2dfeb50f7d6c832
+  metadata.gz: 2619b5d60dc8a3df39b8d739b364832d63025b5eca9024b42619308e753ee51fcbd14dda437a1a1d3269eef2eee3e8acea30841c020b6bfc7da1b9dbd277af94
+  data.tar.gz: 97f62b08426cdbbeae331d10254f8b12e58147074cbecee642d1a4cbe179d4ebd1fd70080cda730d003ec10a2799499f626bc97d5ce92f3ab91189adb3d63d00

data/bin/lwsconsole

@@ -87,13 +87,11 @@ begin
     if @options[:cfg_file]
       cfg_file = @options[:cfg_file]
       raise "config file does not exist: #{cfg_file}" unless File.exist? cfg_file
-      config.load_config_file(cfg_file)
+      config.load_config_file(cfg_file, @options[:environment])
     else
-      config.load_config_file(GLOBAL_CONFIG_FILE)
-      config.load_config_file(USER_CONFIG_FILE)
+      config.load_config_file(GLOBAL_CONFIG_FILE, @options[:environment])
+      config.load_config_file(USER_CONFIG_FILE, @options[:environment])
     end
-
-    config.environment = @options[:environment] if @options[:environment]
   end
   if @options[:app]
     @app_module = LWS.app_module(@options[:app].downcase)
@@ -134,7 +132,11 @@ end
 
 # Set up Pry
 FileUtils.mkdir_p("#{ENV['HOME']}/.local/share/LeftClick")
-Pry.config.history.file = "#{ENV['HOME']}/.local/share/LeftClick/lws_history"
+if Pry.config.history_file
+  Pry.config.history_file = "#{ENV['HOME']}/.local/share/LeftClick/lws_history"
+else
+  Pry.config.history.file = "#{ENV['HOME']}/.local/share/LeftClick/lws_history"
+end
 Pry.config.prompt_name = PROG_NAME
 
 # Print an LWS setup summary
@@ -154,7 +156,7 @@ if LWS.config.http_debug
   end
 end
 debug_outputs << "JSON" if LWS.config.json_debug
-unless debug_outputs.present?
+if debug_outputs.present?
   puts "- Debug output: #{debug_outputs.join(', ')}"
 end
 puts

data/lib/lws.rb

@@ -60,7 +60,7 @@ module LWS
   #     config.api_token_middleware = TokenAuthenticator
   #     config.caching_object = MyRedisCache.new
   #     config.environment = :development
-  #     config.endponts = { maps: "https://maps.leftclick.cloud" }
+  #     config.endpoints = { maps: "https://maps.leftclick.cloud" }
   #     config.http_debug = true
   #     config.json_debug = true
   #     config.logger = Rails.logger
@@ -77,7 +77,11 @@ module LWS
   # @return [LWS] the module itself
   def self.setup(&block)
     @@config = Config.new
-    yield @@config
+
+    # Override the environment if needed
+    if ENV["LC_LWS_ENV"].present?
+      @@config.environment = ENV["LC_LWS_ENV"].to_sym
+    end
 
     # Override the API token if needed (and no custom API token middleware
     # is used)
@@ -85,10 +89,7 @@ module LWS
       @@config.api_token = ENV["LC_LWS_API_TOKEN"]
     end
 
-    # Override the environment if needed
-    if ENV["LC_LWS_ENV"].present?
-      @@config.environment = ENV["LC_LWS_ENV"].to_sym
-    end
+    yield @@config
 
     if config.api_token.blank? and config.api_token_middleware.blank?
       raise LWS::Errors::ConfigError,
@@ -107,8 +108,8 @@ module LWS
   # Sets up the Faraday API object with the current LWS configuration for
   # the given API URL.
   #
-  # @param api_url The endpoint URL of the API
-  # @return [Faraday] A Faraday connection that makes requests to the API
+  # @param api_url [String] The endpoint URL of the API
+  # @return [Faraday::Connection] A Faraday connection that makes requests to the API
   def self.setup_api(api_url)
     api = Faraday.new(url: api_url) do |c|
       # Request

data/lib/lws/apps/digital_signage.rb

@@ -497,6 +497,11 @@ module LWS::DigitalSignage
   class Layout < LWS::Generic::Model
     use_api LWS::DigitalSignage.api
 
+    # @!attribute category_ids
+    #   @return [Array<Integer>] the IDs of the categories assoicated with
+    #     the layout
+    attribute :category_ids
+
     # @!attribute categories
     #   @return [Array<Layout::Category>] the categories associated with
     #     the layout
@@ -504,13 +509,19 @@ module LWS::DigitalSignage
     has_many :categories, class_name: "LWS::DigitalSignage::Layout::Category",
                           uri: "layout/:layout_id/categories(/:id)"
 
-    # @!attribute company
-    #   @return [LWS::Auth::Company] the company the layout belongs to
-    belongs_to :company, class_name: "LWS::Auth::Company"
+    # @!attribute company_owner
+    #   @return [LWS::Auth::Company] the company that owns the layout
+    belongs_to :company_owner, class_name: "LWS::Auth::Company",
+                               foreign_key: :company_owner_id,
+                               uri: "companies/:id"
 
-    # @!attribute company_id
-    #   @return [Integer] the ID of the company the layout belongs to
-    attribute :company_id
+    # @!attribute company_owner_id
+    #   @return [Integer] the ID of the company that owns the layout
+    attribute :company_owner_id
+
+    # @!attribute company_shared_ids
+    #   @return [Array<Integer>] the IDs of the company the layout is shared with
+    attribute :company_shared_ids
 
     # @!attribute default_duration
     #   @return [5..3600] the default duration of a slide created from the layout
@@ -520,6 +531,14 @@ module LWS::DigitalSignage
     #   @return [String, nil] the description of the layout
     attribute :description
 
+    # @!attribute description_html
+    #   @return [String, nil] an HTML version of the description of the layout
+    attribute :description_html
+
+    # @!attribute duration_kind
+    #   @return ["variable", "fixed", "kind"] the duration kind of the layout
+    attribute :duration_kind
+
     # @!attribute favorite
     #   @return [Boolean] whether the layout is a favorite for the current account
     attribute :favorite
@@ -547,11 +566,25 @@ module LWS::DigitalSignage
     #   @return [Boolean] whether the layout has priority over others
     attribute :priority
 
+    # @!attribute public
+    #   @return [Boolean] whether the layout is public (i.e. shared with all
+    #     companies)
+    attribute :public
+
+    # @!attribute rotation
+    #   @return ["landscape", "portrait"] the rotation (orientation) of the
+    #     layout
+    attribute :rotation
+
     # @!attribute slides
     #   @return [Array<Slide>] the slides using the layout
     has_many :slides, class_name: "LWS::DigitalSignage::Slide",
                       uri: "layouts/:layout_id/slides(/:id)"
 
+    # @!attribute thumbnail_url
+    #   @return [String, nil] the URL of the thumbnail of the layout
+    attribute :thumbnail_url
+
     # @!attribute trans
     #   @return ["cut", "fadein", "zoomin", "slidein"] the transition of the
     #     entire layout
@@ -801,9 +834,9 @@ module LWS::DigitalSignage
     #   @return [Integer] the ID of the configuration of the player
     attribute :configuration_id
 
-    # @!attribute feedbacks
-    #   @return [Array<Player::Feedback>] the feedbacks for the player
-    has_many :feedbacks, class_name: "LWS::DigitalSignage::Player::Feedback"
+    # @!attribute feedback
+    #   @return [Hash{String=>String}] a mapping of player feedback key/values
+    attribute :feedback
 
     # @!attribute [r] health_percentage
     #   @return [Fixnum] the health of the player (percentage)
@@ -834,13 +867,17 @@ module LWS::DigitalSignage
     #   @return [Integer] the ID of the model of the player
     attribute :model_id
 
+    # @!attribute name
+    #   @return [String] the name of the player
+    attribute :name
+
     # @!attribute notifications
     #   @return [Array<Player::Notification>] the notifications for the player
     has_many :notifications, class_name: "LWS::DigitalSignage::Player::Notification"
 
-    # @!attribute operational_hours [r]
+    # @!attribute operation_hours [r]
     #   @return [String, nil] the number of hours the player has been operational
-    attribute :operational_hours
+    attribute :operation_hours
 
     # @!attribute operational_since [r]
     #   @return [String, nil] the date/time when the player became operational
@@ -871,7 +908,7 @@ module LWS::DigitalSignage
     attribute :release_channel_id
 
     # @!attribute requests
-    #   @return [Array<Player::Feedback>] the requests for the player
+    #   @return [Array<Player::Request>] the requests for the player
     has_many :requests, class_name: "LWS::DigitalSignage::Player::Request"
 
     # @!attribute screenshots
@@ -890,6 +927,15 @@ module LWS::DigitalSignage
     #   @return ["unknown", "good", "warning", "bad"] the player status
     attribute :status
 
+    # @!attribute status_reason [r]
+    #   @return ["unknown", "hardware_failure", "outdated_os", "good", "connection_inactive_short",
+    #            "connection_inactive_long"] the reason for the current player status
+    attribute :status_reason
+
+    # @!attribute status_updated_at [r]
+    #   @return [String] the date/time the status was last updated
+    attribute :status_updated_at
+
     # @!attribute tags
     #   @return [Array<Player::Tag>] the tags of the player
     has_many :tags, class_name: "LWS::DigitalSignage::Player::Tag"
@@ -1040,75 +1086,6 @@ module LWS::DigitalSignage
     attribute :value
   end
 
-  # = The player feedback class
-  #
-  # @note
-  #   This class is only used within the context of the {Player} class.
-  class Player::Feedback < LWS::Generic::Model
-    use_api LWS::DigitalSignage.api
-    uri "players/:player_id/feedbacks(/:id)"
-
-    # @!attribute player
-    #   @return [Player] the player the feedback is originating from
-    belongs_to :player, class_name: "LWS::DigitalSignage::Player"
-
-    # @!attribute player_id
-    #   @return [Integer] the ID of the player the feedback is originating from
-    attribute :player_id
-
-    # @!attribute release
-    #   @return [Player::Os::Branch::Release] the player OS branch release the
-    #      feedback is related to
-    # FIXME: Missing branch_id field in LWS
-    belongs_to :release, class_name: "LWS::DigitalSignage::Player::Os::Branch::Release",
-                         uri: "player/os/branches/:branch_id/releases/:id"
-
-    # @!attribute release_id
-    #   @return [Integer] the ID of the player OS branch release the feedback
-    #     is related to
-
-    # @!attribute results
-    #   @return [Array<Player::Feedback::Result>] the results of the player feedback
-    # FIXME: Chained associations don't work yet in Spyke (#89)
-    has_many :results, class_name: "LWS::DigitalSignage::Player::Feedback::Result",
-                       uri: "players/:player_id/feedbacks/:feedback_id/results(/:id)"
-  end
-
-  # = The player feedback result class
-  #
-  # @note
-  #   This class is only used within the context of the {Player::Feedback}
-  #   class.
-  class Player::Feedback::Result < LWS::Generic::Model
-    use_api LWS::DigitalSignage.api
-    uri "players/:player_id/feedbacks/:feedback_id/results(/:id)"
-
-    # @!attribute feedback
-    #   @return [Player::Feedback] the player feedback the result is a part of
-    belongs_to :feedback, class_name: "LWS::DigitalSignage::Player::Feedback",
-                          uri: "players/:player_id/feedbacks/:id"
-
-    # @!attribute feedback_id
-    #   @return [Player::Feedback] the ID of the player feedback the result is a part of
-    attribute :feedback_id
-
-    # @!attribute key
-    #   @return [String] the key of the player feedback result
-    attribute :key
-
-    # @!attribute player
-    #   @return [Player] the player the feedback result is for
-    belongs_to :player, class_name: "LWS::DigitalSignage::Player"
-
-    # @!attribute player_id
-    #   @return [Integer] the ID of the player the feedback result is for
-    attribute :player_id
-
-    # @!attribute value
-    #   @return [String] the value of the player feedback result
-    attribute :value
-  end
-
   # = The player log class
   #
   # @note
@@ -1632,20 +1609,6 @@ module LWS::DigitalSignage
     #   @return [String, nil] the optional argument for the player request
     attribute :argument
 
-    # @!attribute feedback
-    #   This field should be set once the action has been processed (see
-    #   {#processed}) and the action is +"send_feedback"+.
-    #
-    #   @return [Player::Feedback, nil] the player feedback as a response to the
-    #     action request +"send_status"+
-    belongs_to :feedback, class_name: "LWS::DigitalSignage::Player::Feedback",
-                          uri: "players/:player_id/feedbacks/:id"
-
-    # @!attribute feedback_id
-    #   @return [Integer, nil] the ID of the player feedback as a response to the
-    #     action request +"send_status"+
-    attribute :feedback_id
-
     # @!attribute log
     #   This field should be set once the action has been processed (see
     #   {#processed}) and the action is +"send_logs"+.
@@ -1764,6 +1727,10 @@ module LWS::DigitalSignage
     #     scheduled on
     has_many :channel_groups, class_name: "LWS::DigitalSignage::Channel::Group"
 
+    # @!attribute comments
+    #   @return [String, nil] the comments/remarks for the slide
+    attribute :comments
+
     # @!attribute company
     #   @return [LWS::Auth::Company] the company the slide belongs to
     belongs_to :company, class_name: "LWS::Auth::Company"
@@ -1772,6 +1739,19 @@ module LWS::DigitalSignage
     #   @return [Integer] the ID of the company the slide belongs to
     attribute :company_id
 
+    # @!attribute duration
+    #   @return [Integer, nil] the duration of the slide (for fixed or content-bound durations
+    #     in the layout)
+    attribute :duration
+
+    # @!attribute edit_account_ids
+    #   @return [Array<Integer>] the IDs of the accounts that can edit the slide
+    attribute :edit_account_ids
+
+    # @!attribute editable_by_me
+    #   @return [Boolean] whether the authenticated user can edit the slide
+    attribute :editable_by_me
+
     # @!attribute layout
     #   @return [LWS::Layout] the layout the slide uses
     belongs_to :layout
@@ -1790,13 +1770,16 @@ module LWS::DigitalSignage
 
     # @!attribute schedules
     #   @return [Array<Schedule>] the slide schedules that apply for the slide
-    # FIXME: Missing endpoint in LWS
     has_many :schedules, class_name: "LWS::DigitalSignage::Slide::Schedule"
 
     # @!attribute status [r]
     #   @return ["initializing", "waiting_content", "available", "error"]
     #     the status of the slide
     attribute :status
+
+    # @!attribute thumbnail_url
+    #   @return [String, nil] the URL of the thumbnail of the slide
+    attribute :thumbnail_url
   end
 
   # = The slide schedule class

data/lib/lws/apps/generic.rb

@@ -79,8 +79,10 @@ module LWS::Generic
     # Sets the Faraday API object used for this class.  This will used by
     # Spyke.
     #
-    # @param api The Faraday connection that makes requests to the API
-    # @return [Faraday] A Faraday connection that makes requests to the API
+    # @param [Faraday::Connection] api A Faraday connection that makes
+    #   requests to the API
+    # @return [Faraday::Connection] The Faraday connection that makes requests
+    #   to the API
     def self.use_api(api)
       self.connection = api
       self.include_root_in_json self.name.split("::").last.underscore.to_sym
@@ -150,8 +152,9 @@ module LWS::Generic
       result
     end
 
-    # Extracts a nested attribute vlaue specified by the sequence of attribute names
+    # Extracts a nested attribute value specified by the sequence of attribute names
     # by calling dig at each step, returning +nil+ if any intermediate step is +nil+.
+    # @return [Object, nil] the digged up value or +nil+
     def dig(*attrs)
       attr = attrs.shift
       value = send(attr)
@@ -161,6 +164,20 @@ module LWS::Generic
       value.dig(*attrs)
     end
 
+    # Returns a deep copy of the model.
+    # @return [Model] a deep copy of the model
+    def deep_dup
+      dup_obj = super
+      dup_obj.instance_eval do
+        @changed_attributes = @changed_attributes.deep_dup
+        @previously_changed = @previously_changed.deep_dup
+        @scope = @scope.deep_dup
+        @spyke_attributes = @spyke_attributes.deep_dup
+        @uri_template = @uri_template.deep_dup
+      end
+      dup_obj
+    end
+
   end
 
   # = The configuration class
@@ -180,9 +197,11 @@ module LWS::Generic
   class Storage
     # @!visibility private
     def self.use_api(api)
-      @connection = Faraday.new(url: api.url_prefix) do |c|
-        config = LWS.config
+      config = LWS.config
 
+      # A connection to Active Storage (with JSON request/response, but without
+      # token authentication and caching).
+      @as_connection = Faraday.new(url: api.url_prefix) do |c|
         # Request
         c.request :json
 
@@ -197,6 +216,36 @@ module LWS::Generic
           c.adapter Faraday.default_adapter
         end
       end
+
+      # A plain file connection to LWS (with token autnentication and caching but without
+      # JSON request/response).
+      @lws_connection = Faraday.new(url: api.url_prefix) do |c|
+        # Request
+        if config.caching_object
+          c.use FaradayMiddleware::Caching, 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
+
+        # Adapter
+        if config.http_persistent
+          c.adapter :net_http_persistent
+        else
+          c.adapter Faraday.default_adapter
+        end
+      end
+    end
+
+    # (see .upload)
+    # @deprecated
+    #   To have a consistent upload/download naming counterpart, this
+    #   method has been deprecated. Use {.upload} instead.
+    def self.create(file_or_io, filename, content_type = "application/octet-stream")
+      upload(file_or_io, filename, content_type)
     end
 
     # Uploads a file (or IO object) to the storage of the app module.
@@ -208,7 +257,7 @@ module LWS::Generic
     # @param filename [String] the filename to use for the uploaded file/IO object
     # @param content_type [String] the content type of the uploaded file/IO object
     # @return [String, nil] the storage ID (if successful)
-    def self.create(file_or_io, filename, content_type = "application/octet-stream")
+    def self.upload(file_or_io, filename, content_type = "application/octet-stream")
       return nil if file_or_io.closed?
 
       data = file_or_io.read
@@ -217,7 +266,7 @@ module LWS::Generic
                        content_type: content_type,
                        byte_size: data.length,
                        checksum: checksum } }
-      res = @connection.post do |req|
+      res = @as_connection.post do |req|
         req.url "rails/active_storage/direct_uploads"
         req.headers["Accept"] = "application/json"
         req.headers["Content-Type"] = "application/json"
@@ -226,7 +275,7 @@ module LWS::Generic
 
       if res.success?
         result = JSON.parse(res.body)
-        res = @connection.put do |req|
+        res = @as_connection.put do |req|
           req.url result.dig("direct_upload", "url")
           result.dig("direct_upload", "headers").each do |hdr, val|
             req.headers[hdr] = val
@@ -240,6 +289,24 @@ module LWS::Generic
         nil
       end
     end
-  end
 
+    # Downloads a file at the provided URL from the storage using the
+    # appropriate API tokens.
+    #
+    # This method can be used to download images/assets/etc. from LWS using
+    # URLs provided by attributes that end with +_url+.
+    # @param url [String] the URL to download the file from
+    # @return [String] the contents of the file
+    def self.download(url)
+      return nil if url.nil?
+
+      unless url.start_with? @lws_connection.url_prefix.to_s
+        raise ArgumentError,
+          "URL does not belong to this LWS app (endpoint: #{@lws_connection.url_prefix})"
+      end
+
+      res = @lws_connection.get(url)
+      res.body
+    end
+  end
 end

data/lib/lws/apps/presence.rb

@@ -88,6 +88,46 @@ module LWS::Presence
     attribute :uuid
   end
 
+  # = The journal (entry) class
+  #
+  # @note
+  #   This class is only used within the context of the {Location} class.
+  class Journal < LWS::Generic::Model
+    use_api LWS::Presence.api
+
+    # @!attribute check_in
+    #   @return [String] the timestamp of the check-in of this journal (entry)
+    attribute :check_in
+
+    # @!attribute check_out
+    #   @return [String, nil] the timestamp of the check out of this journal (entry)
+    attribute :check_out
+
+    # @!attribute company
+    #   @return [LWS::Auth::Company] the company the journal (entry) belongs to
+    belongs_to :company, class_name: "LWS::Auth::Company"
+
+    # @!attribute company_id
+    #   @return [Integer] the ID of the company the journal (entry) belongs to
+    attribute :company_id
+
+    # @!attribute location
+    #   @return [Location] the location the journal (entry) belongs to
+    belongs_to :location
+
+    # @!attribute location_id
+    #   @return [Integer] the ID of the location the journal (entry) belongs to
+    attribute :location_id
+
+    # @!attribute person
+    #   @return [Person] the person the journal (entry) belongs to
+    belongs_to :person
+
+    # @!attribute person_id
+    #   @return [Integer] the ID of the person the journal (entry) belongs to
+    attribute :person_id
+  end
+
   # = The location class
   class Location < LWS::Generic::Model
     use_api LWS::Presence.api
@@ -133,6 +173,14 @@ module LWS::Presence
     #     the presence status to set people to when checking in
     attribute :checkin_status
 
+    # @!attribute checkout_alter_status
+    #   @return ["available", "unavailable", "maintenance_cleaning",
+    #     "maintenance_technical", "permanent_available",
+    #     "permanent_unavailable", "permanent_maintenance_cleaning",
+    #     "permanent_maintenance_technical", nil] the status to set the
+    #     location to when someone checks out
+    attribute :checkout_alter_status
+
     # @!attribute checkout_location
     #   @return [Location, nil] the location to move people to when they
     #     are checked out
@@ -157,13 +205,28 @@ module LWS::Presence
     #   @return [Array<Integer>] the IDs of the underlying locations of the location
     attribute :descendant_ids
 
+    # @!attribute image_storage_id
+    #   @return [String, nil] the storage ID of the image of the location
+    attribute :image_storage_id
+
+    # @!attribute image_url
+    #   @note
+    #     To be able retrieve this, the token needs to be passed via +X-Token+
+    #     in the HTTP request headers!
+    #   @return [String, nil] the URL of the image of the location
+    attribute :image_url
+
+    # @!attribute journals
+    #   @return [Array<Journal>] the journal (entries) associated with the location
+    has_many :journals, class: "LWS::Presence::Journal"
+
     # @!attribute lat
     #   @return [Float] the latitude of the location
     attribute :lat
 
     # @!attribute logoff_time
-    # The format of the time is +HH:MM+ and should be interpreted in the time zone
-    # of the location (see also {#time_zone}).
+    #   The format of the time is +HH:MM+ and should be interpreted in the time zone
+    #   of the location (see also {#time_zone}).
     #   @return [String] the time everybody is automatically logged off
     attribute :logoff_time
 
@@ -221,6 +284,13 @@ module LWS::Presence
     #   @return [Array<Reader>] the (RFID/code/ID/...) readers linked to this location
     has_many :readers
 
+    # @!attribute status
+    #   @return ["available", "unavailable", "maintenance_cleaning",
+    #     "maintenance_technical", "permanent_available",
+    #     "permanent_unavailable", "permanent_maintenance_cleaning",
+    #     "permanent_maintenance_technical"] the status of the location
+    attribute :status
+
     # @!attribute time_zone
     #   @return [String] the time zone of the location
     attribute :time_zone
@@ -238,6 +308,17 @@ module LWS::Presence
     use_api LWS::Presence.api
     uri "locations/:location_id/maps(/:id)"
 
+    # @!attribute image_storage_id
+    #   @return [String, nil] the storage ID of the image of the map
+    attribute :image_storage_id
+
+    # @!attribute image_url
+    #   @note
+    #     To be able retrieve this, the token needs to be passed via +X-Token+
+    #     in the HTTP request headers!
+    #   @return [String, nil] the URL of the image of the map
+    attribute :image_url
+
     # @!attribute location
     #   @return [Location] the location the map belongs to
     belongs_to :location
@@ -251,6 +332,9 @@ module LWS::Presence
     attribute :name
 
     # @!attribute picture_url
+    #   @deprecated
+    #     Unauthenticated retrieval of the picture will not longer be supported
+    #     in upcoming releases of LWS. Use {#image_url} instead!
     #   @return [String, nil] the URL of the picture of the map
     attribute :picture_url
 
@@ -359,6 +443,17 @@ module LWS::Presence
     #   @return [Array<Appointment>] the appointments involving the person
     has_many :appointments
 
+    # @!attribute avatar_storage_id
+    #   @return [String, nil] the storage ID of the avatar of the person
+    attribute :avatar_storage_id
+
+    # @!attribute avatar_url
+    #   @note
+    #     To be able retrieve this, the token needs to be passed via +X-Token+
+    #     in the HTTP request headers!
+    #   @return [String, nil] the URL of the avatar of the person
+    attribute :avatar_url
+
     # @!attribute company
     #   @return [LWS::Auth::Company] the company the person belongs to
     belongs_to :company, class_name: "LWS::Auth::Company"
@@ -422,6 +517,14 @@ module LWS::Presence
     #   @return [Integer] the ID of the location the person is located at
     attribute :location_id
 
+    # @!attribute location_status_change_permissions
+    #   @return [Array<"available", "unavailable", "maintenance_cleaning",
+    #     "maintenance_technical", "permanent_available",
+    #     "permanent_unavailable", "permanent_maintenance_cleaning",
+    #     "permanent_maintenance_technical">] the location statuses the person
+    #     will clear to available on check-in
+    attribute :location_status_change_permissions
+
     # @!attribute long
     #   @return [Float, nil] the exact longitude of the person's location
     attribute :long
@@ -457,6 +560,9 @@ module LWS::Presence
     attribute :phone_mobile
 
     # @!attribute picture_url
+    #   @deprecated
+    #     Unauthenticated retrieval of the picture will not longer be supported
+    #     in upcoming releases of LWS. Use {#avatar_url} instead!
     #   @return [String, nil] the URL of the picture of the person
     attribute :picture_url
 
@@ -512,4 +618,9 @@ module LWS::Presence
     attribute :node
   end
 
+  # (see Generic::Storage)
+  class Storage < LWS::Generic::Storage
+    use_api LWS::Presence.api
+  end
+
 end

data/lib/lws/config.rb

@@ -107,11 +107,15 @@ module LWS
     #     http_debug: true
     #     json_debug: true
     #
+    # @param config_file [String] the path to the config file to load
+    # @param force_environment [Symbol, nil] the environment to enforce (if
+    #   any)
     # @return [Boolean] whether the config file was used
-    def load_config_file(config_file)
+    def load_config_file(config_file, force_environment = nil)
       return false unless File.exist? config_file
       config_data = YAML.load_file(config_file)
-      environment = ENV["LC_LWS_ENV"] ||
+      environment = force_environment ||
+                    ENV["LC_LWS_ENV"] ||
                     config_data.dig("default", "environment") ||
                     self.environment
       self.environment = environment.to_sym
@@ -122,20 +126,26 @@ module LWS
           raise "encountered an invalid config property \"#{key}\" " +
                 "in config file #{config_file}!"
         end
+        configure(key, value)
+      end
+      true
+    end
+
+    private
 
-        case key
-        when "endpoints"
-          if self.endpoints.empty?
-            self.endpoints = value.inject({}) do |h, (k, v)|
-                               h[k.to_sym] = v
-                               h
-                             end
-          end
-        else
-          self[key.to_sym] = value unless self[key.to_sym]
+    def configure(key, value)
+      case key
+      when "endpoints"
+        if self.endpoints.empty?
+          configure_endpoints(value)
         end
+      else
+        self[key.to_sym] ||= value
       end
-      true
+    end
+
+    def configure_endpoints(endpoints)
+      self.endpoints = endpoints.transform_keys(&:to_sym)
     end
 
   end

data/lib/lws/version.rb

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

data/test/corporate_website_test.rb

@@ -16,7 +16,7 @@ class TestCorporateWebsiteArticle < MiniTest::Test
   include LWS::CorporateWebsite
 
   def setup
-    @page = Page.all.first
+    @page = Page.find(1)
     @article = @page.articles.first
   end
 
@@ -38,7 +38,7 @@ class TestCorporateWebsiteOfficeTime < MiniTest::Test
   include LWS::CorporateWebsite
 
   def setup
-    @office_time = OfficeTime.all.first
+    @office_time = OfficeTime.find(1)
   end
 
   def test_valid
@@ -54,7 +54,7 @@ class TestCorporateWebsitePage < MiniTest::Test
   include LWS::CorporateWebsite
 
   def setup
-    @page = Page.all.first
+    @page = Page.find(1)
   end
 
   def test_valid
@@ -75,7 +75,7 @@ end
 #  include LWS::CorporateWebsite
 #
 #  def setup
-#    @social_page = SocialPage.all.first
+#    @social_page = SocialPage.find(1)
 #  end
 #
 #  def test_valid
@@ -96,7 +96,7 @@ class TestCorporateWebsiteSocialPost < MiniTest::Test
   include LWS::CorporateWebsite
 
   def setup
-    @social_post = SocialPost.all.first
+    @social_post = SocialPost.find(1)
   end
 
   def test_valid

data/test/digital_signage_test.rb

@@ -261,6 +261,7 @@ class TestDigitalSignageLayout < MiniTest::Test
   def test_valid_associations
     # FIXME: Missing endpoint in LWS
     #assert_instance_of(Layout::Category, @layout.categories.first)
+    assert_instance_of(LWS::Auth::Company, @layout.company_owner)
     # FIXME: Missing parent_id field in LWS
     #assert_instance_of(Layout, @layout.parent)
     # FIXME: Missing endpoint in LWS
@@ -530,64 +531,6 @@ class TestDigitalSignagePlayerConfigurationSetting < MiniTest::Test
 
 end
 
-class TestDigitalSignagePlayerFeedback < MiniTest::Test
-
-  include LWS::DigitalSignage
-
-  def setup
-    @player = Player.find(1)
-    # Player feedbacks only exist as child objects of players
-    @player_feedback = @player.feedbacks.first
-  end
-
-  def test_valid
-    refute_nil(@player_feedback)
-    assert_instance_of(Player::Feedback, @player_feedback)
-    refute_nil(@player_feedback.id)
-  end
-
-  def test_valid_associations
-    assert_instance_of(Player, @player_feedback.player)
-    assert_equal(@player, @player_feedback.player)
-    # FIXME: Missing branch_id field in LWS
-    #assert_instance_of(Player::Os::Branch::Release, @player_feedback.release)
-    # FIXME: Chained associations don't work yet in Spyke (#89)
-    #assert_instance_of(Player::Feedback::Result, @player_feedback.results.first)
-  end
-
-end
-
-class TestDigitalSignagePlayerFeedbackResult < MiniTest::Test
-
-  include LWS::DigitalSignage
-
-  def setup
-    @player = Player.find(1)
-    # Player feedbacks only exist as decendant objects of players
-    @player_feedback = @player.feedbacks.all.first
-    # Player feedback results only exist as decendant objects of player
-    # feedbacks
-    # FIXME: Chained associations don't work yet in Spyke (#89)
-    #@player_feedback_result = @player_feedback.results.first
-  end
-
-  # FIXME: Chained associations don't work yet in Spyke (#89)
-  #def test_valid
-  #  refute_nil(@player_feedback_result)
-  #  assert_instance_of(Player::Feedback::Result, @player_feedback_result)
-  #  refute_nil(@player_feedback_result.id)
-  #end
-
-  # FIXME: Chained associations don't work yet in Spyke (#89)
-  #def test_valid_associations
-  #  assert_instance_of(Player, @player_feedback_result.player)
-  #  assert_equal(@player, @player_feedback_result.player)
-  #  assert_instance_of(Player::Feedback, @player_feedback_result.feedback)
-  #  assert_equal(@player_feedback, @player_feedback_result.feedback)
-  #end
-
-end
-
 class TestDigitalSignagePlayerLog < MiniTest::Test
 
   include LWS::DigitalSignage
@@ -930,9 +873,7 @@ class TestDigitalSignagePlayerRequest < MiniTest::Test
     assert_equal(@player, @player_request.player)
     # FIXME: Chained associations don't work yet in Spyke (#89)
     #if @player_request.processed
-    #  if @player_request.feedback.present?
-    #    assert_instance_of(Player::Feedback, @player_request.feedback)
-    #  elsif @player_request.log.present?
+    #  if @player_request.log.present?
     #    assert_instance_of(Player::Log, @player_request.log)
     #  elsif @player_request.screenshot.present?
     #    assert_instance_of(Player::Screenshot, @player_request.screenshot)
@@ -1010,6 +951,7 @@ class TestDigitalSignageSlide < MiniTest::Test
     assert_instance_of(Channel::Group, @slide.channel_groups.first)
     assert_instance_of(LWS::Auth::Company, @slide.company)
     assert_instance_of(Layout, @slide.layout)
+    assert_instance_of(Slide::Schedule, @slide.schedules.first)
   end
 
 end
@@ -1021,20 +963,17 @@ class TestDigitalSignageSlideSchedule < MiniTest::Test
   def setup
     @slide = Slide.find(1)
     # Slide schedules only exist as decendant objects of players
-    # FIXME: Endpoint is missing in LWS
     @slide_schedule = @slide.schedules.first
   end
 
-  # FIXME: Endpoint is missing in LWS
-  #def test_valid
-  #  refute_nil(@slide_schedule)
-  #  assert_instance_of(Slide::Schedule, @slide_schedule)
-  #  refute_nil(@slide_schedule.id)
-  #end
+  def test_valid
+    refute_nil(@slide_schedule)
+    assert_instance_of(Slide::Schedule, @slide_schedule)
+    refute_nil(@slide_schedule.id)
+  end
 
-  # FIXME: Endpoint is missing in LWS
   #def test_valid_associations
-  #  assert_instance_of(Slide, @slide_schedules.slides.first)
+  #  assert_instance_of(Slide, @slide_schedule.slides.first)
   #end
 
 end

data/test/generic_test.rb

@@ -17,7 +17,7 @@ class TestGenericModel < MiniTest::Test
   include LWS::Auth
 
   def setup
-    @configuration = Configuration.all.first
+    @configuration = Configuration.find(1)
   end
 
   def test_her_compatibility
@@ -106,6 +106,20 @@ class TestGenericModel < MiniTest::Test
     end
   end
 
+  def test_deep_dup
+    company = LWS::Auth::Company.find(1)
+    company_dup = company.deep_dup
+
+    # The object itself
+    refute_equal(company.object_id, company_dup.object_id)
+    # An object as attribute value
+    refute_equal(company.address.object_id, company_dup.address.object_id)
+    # A related object
+    refute_equal(company.contact_person.object_id, company_dup.contact_person.object_id)
+    # An item in array of related objects
+    refute_equal(company.accounts.first.object_id, company_dup.accounts.first.object_id)
+  end
+
 end
 
 class TestGenericConfiguration < MiniTest::Test
@@ -114,7 +128,7 @@ class TestGenericConfiguration < MiniTest::Test
   include LWS::Auth
 
   def setup
-    @configuration = Configuration.all.first
+    @configuration = Configuration.find(1)
   end
 
   def test_valid
@@ -128,15 +142,37 @@ end
 class TestGenericStorage < MiniTest::Test
 
   # Generic class needs to be accessed under some kind of app
-  include LWS::Resource
+  include LWS::Presence
 
   def test_upload
     data = StringIO.new("some file contents\n")
+    refute_nil(Storage.upload(data, "test.txt", "text/plain"))
+
+    # Test the deprecated method (for now)
     refute_nil(Storage.create(data, "test.txt", "text/plain"))
 
     # Also test using the default HTTP adapter.
     reconfigure(http_persistent: false)
     data = StringIO.new("some more file contents\n")
-    refute_nil(Storage.create(data, "test2.txt", "text/plain"))
+    refute_nil(Storage.upload(data, "test2.txt", "text/plain"))
+  end
+
+  def test_download
+    location = Location.find(1)
+    refute_nil(location.image_url)
+
+    data = Storage.download(location.image_url)
+    assert(data.size > 0)
+
+    assert_nil(Storage.download(nil))
+
+    assert_raises(ArgumentError) do
+      Storage.download("https://doesnot.exist.tld/some/file")
+    end
+
+    # Also test using the default HTTP adapter.
+    reconfigure(http_persistent: false)
+    data = Storage.download(location.image_url)
+    assert(data.size > 0)
   end
 end

data/test/maps_test.rb

@@ -16,7 +16,7 @@ class TestMapsMap < MiniTest::Test
   include LWS::Maps
 
   def setup
-    @map = Map.all.first
+    @map = Map.find(1)
   end
 
   def test_valid_map
@@ -37,7 +37,7 @@ class TestMapsMarker < MiniTest::Test
   include LWS::Maps
 
   def setup
-    @map = Map.all.first
+    @map = Map.find(1)
     # Markers only exist as child objects of maps
     @marker = @map.markers.first
   end
@@ -60,7 +60,7 @@ class TestMapsSource < MiniTest::Test
   include LWS::Maps
 
   def setup
-    @source = Source.all.first
+    @source = Source.find(1)
   end
 
   def test_valid_source

data/test/presence_test.rb

@@ -35,6 +35,29 @@ class TestPresenceAppointment < MiniTest::Test
 
 end
 
+class TestPresenceJournal < MiniTest::Test
+  include LWS::Presence
+
+  def setup
+    @location = Location.find(1)
+    # Journals only exist as child objects of a location
+    @journal = @location.journals.first
+  end
+
+  def test_valid
+    refute_nil(@journal)
+    assert_instance_of(Journal, @journal)
+    refute_nil(@journal.id)
+  end
+
+  def test_valid_associations
+    assert_instance_of(LWS::Auth::Company, @journal.company)
+    assert_instance_of(Location, @journal.location)
+    assert_equal(@location, @journal.location)
+    assert_instance_of(Person, @journal.person)
+  end
+end
+
 class TestPresenceLocation < MiniTest::Test
 
   include LWS::Presence
@@ -165,7 +188,7 @@ class TestPresenceReader < MiniTest::Test
   include LWS::Presence
 
   def setup
-    @reader = Reader.all.first
+    @reader = Reader.find(1)
   end
 
   def test_valid

data/test/resource_test.rb

@@ -25,7 +25,7 @@ class TestResourceCollection < MiniTest::Test
   include LWS::Resource
 
   def setup
-    @collection = Collection.all.first # FIXME
+    @collection = Collection.find(1)
   end
 
   def test_valid
@@ -48,7 +48,7 @@ class TestResourceCollectionItem < MiniTest::Test
   include LWS::Resource
 
   def setup
-    @collection = Collection.where(includes: "items").first # FIXME
+    @collection = Collection.where(includes: "items").find(1)
     @collection_item = @collection.items.first
   end
 
@@ -70,7 +70,7 @@ class TestResourceFolder < MiniTest::Test
   include LWS::Resource
 
   def setup
-    @folder = Folder.all.first
+    @folder = Folder.find(1)
   end
 
   def test_valid

data/test/setup_test.rb

@@ -71,7 +71,6 @@ class TestSetup < MiniTest::Test
 
   def test_load_config_files
     orig_config = LWS.config.dup
-
     reconfigure do |config|
       assert config.load_config_file(File.join(@test_config_dir, "empty.yml"))
     end
@@ -113,6 +112,20 @@ class TestSetup < MiniTest::Test
     assert_equal(true, LWS.config.http_debug)
     assert_equal(true, LWS.config.http_debug_headers)
     assert_equal(true, LWS.config.json_debug)
+
+    with_env("LC_LWS_ENV" => "production") do
+      reconfigure do |config|
+        assert config.load_config_file(File.join(@test_config_dir, "empty.yml"),
+                                       :development)
+      end
+      assert_equal(:development, LWS.config.environment)
+    end
+
+    reconfigure do |config|
+      assert config.load_config_file(File.join(@test_config_dir, "switch_env.yml"),
+                                     :development)
+    end
+    assert_equal(:development, LWS.config.environment)
   end
 
 end

data/test/test_helper.rb

@@ -23,7 +23,7 @@ SimpleCov.at_exit do
   result.format!
   simplecov_test_suites = ['minitest']
   parallel_offset = ENV['PARALLEL_TEST_GROUPS'] ? ENV['PARALLEL_TEST_GROUPS'].to_i - 1 : 0
-  minimum_coverage = 97
+  minimum_coverage = 95
   # Count the number of commas in the command name to figure out how many result groups were combined into this result
   if result.command_name.scan(/,/).size + 1 >= simplecov_test_suites.size + (parallel_offset * 2) # two parallel suites
     # We only want to enforce minimum coverage after all test suites finish
@@ -49,14 +49,18 @@ raise "Test token not set" if ENV["LC_LWS_TEST_TOKEN"].blank?
 
 def reconfigure(options = {}, &block)
   LWS.setup do |config|
-    config.api_token = ENV["LC_LWS_TEST_TOKEN"]
+    if ENV["LC_LWS_API_TOKEN"].blank?
+      config.api_token = ENV["LC_LWS_TEST_TOKEN"]
+    end
     if ENV["LC_LWS_TEST_DEBUG"].present?
       config.logger = Logger.new($stdout)
       config.http_debug = true
       config.http_debug_headers = false
       config.json_debug = true
     end
-    config.environment = :development
+    if ENV["LC_LWS_ENV"].blank?
+      config.environment = :development
+    end
 
     # Override the config with the given options.
     options.each do |key, value|

data/test/ticket_test.rb

@@ -40,7 +40,7 @@ class TestTicketGroup < MiniTest::Test
   include LWS::Ticket
 
   def setup
-    @group = Group.all.first
+    @group = Group.find(1)
   end
 
   def test_valid
@@ -88,7 +88,7 @@ class TestTicketTag < MiniTest::Test
   include LWS::Ticket
 
   def setup
-    @tag = Tag.all.first
+    @tag = Tag.find(1)
   end
 
   def test_valid_tag

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lws
 version: !ruby/object:Gem::Version
-  version: 7.0.2
+  version: 7.1.3
 platform: ruby
 authors:
 - LeftClick B.V.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-19 00:00:00.000000000 Z
+date: 2020-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
@@ -296,27 +296,27 @@ signing_key:
 specification_version: 4
 summary: LeftClick web services library for Ruby
 test_files:
-- test/fixtures/auth.yml
+- test/presence_test.rb
 - test/fixtures/permissions.yml
-- test/json_parser_test.rb
-- test/test_helper.rb
-- test/setup_test.rb
-- test/auth_test.rb
+- test/fixtures/auth.yml
+- test/corporate_website_test.rb
+- test/logger_test.rb
+- test/support/with_env.rb
 - test/stubbing_test.rb
+- test/ticket_test.rb
 - test/digital_signage_test.rb
-- test/api_token_middleware_test.rb
-- test/config/full.yml
+- test/caching_test.rb
+- test/auth_test.rb
+- test/maps_test.rb
+- test/json_parser_test.rb
+- test/resource_test.rb
+- test/config/endpoints.yml
 - test/config/switch_env.yml
 - test/config/invalid.yml
-- test/config/tokens.yml
 - test/config/empty.yml
-- test/config/endpoints.yml
-- test/maps_test.rb
-- test/logger_test.rb
-- test/ticket_test.rb
-- test/support/with_env.rb
-- test/caching_test.rb
-- test/presence_test.rb
-- test/corporate_website_test.rb
-- test/resource_test.rb
+- test/config/tokens.yml
+- test/config/full.yml
+- test/setup_test.rb
+- test/api_token_middleware_test.rb
 - test/generic_test.rb
+- test/test_helper.rb