lws 7.1.2 → 7.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6ddf096778ba5030a935df95f904a65776bbd8b2dd30602e3c9d912124fb5cd
-  data.tar.gz: 739154dc2c9598eef580f9a562cff9ddccde3a0828e985c55429ceed74f03a5d
+  metadata.gz: 350e54af9f57bb0b94f8f51248803a4e6fa9e2f421756e4d2bac70366ce23fff
+  data.tar.gz: 7ea50f13efa607f5cca37a78f4017bb3b538c203ebd186a1de981bc56d9d7aab
 SHA512:
-  metadata.gz: c6f4e39e00a7277ed012c6d4a2a846dae249edf892db185d17c5a62efa012902bc388ed4e652a26e25eb30ea07e208fbe4ef08b19671c750a0e3f33aa719f8a5
-  data.tar.gz: 696ae43f1ed90d4674365f86d63d411fc21544cce16ba250079e0bcefef1143c9d908c6e01b18773b006fa9a704e45ebc85795ff044c28948bf16fb79f4da042
+  metadata.gz: e2d6398954478aa49996571f6925c9272c325e2fe33da50ecced8945788babb92db0a8ca55b5f959216c242dee51b39ff89eb14a1b7b34d85ebebf5b2dfa34a0
+  data.tar.gz: f269968ac27d608b2ccced085c4ae425818039340262c5e66bbdded3cc4f3438f781e1add2c15a9b503199c5996f47b0788ccd98c692300f560530fa0df5caf2

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)
@@ -158,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

@@ -1,15 +1,16 @@
 #
-# Copyright © 2016 LeftClick B.V.
+# Copyright © 2016–2020 LeftClick B.V.
 #
 # This software is property of LeftClick 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 B.V. at:  Geldropseweg 8B, 5731 SG Mierlo, The
-# Netherlands, info@leftclick.eu, +31492-782120.
+# contact LeftClick B.V. at:  Schootense Dreef 20A, 5708 HZ Helmond, The
+# Netherlands, info@leftclick.eu, +3185-4444-004.
 
 
 require "faraday_middleware"
+require "faraday/http_cache"
 require "hashie"
 require "multi_json"
 require "spyke"
@@ -43,7 +44,7 @@ module LWS
   # @return [Config] the API configuration for the web services
   mattr_reader :config
 
-  # @return [Stubbing] the stubbing setup for the web service
+  # @return [Stubbing] the stubbing setup for the web services
   mattr_reader :stubbing
 
   # Sets up the application API libraries using the provided
@@ -73,11 +74,15 @@ module LWS
   #
   # @yieldparam [Config] config an API configuration object that can be
   #   configured
-  # @raise [LWS::Errors::ConfigError] if the API token is not configured/found
+  # @raise [LWS::Errors::ConfigError] if the API token is not configured/found afterwards
   # @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 +90,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,14 +109,20 @@ 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
       if config.caching_object
         c.use FaradayMiddleware::Caching, config.caching_object
       end
+      if config.http_caching
+        logger = config.http_debug ? config.logger : nil
+        c.use Faraday::HttpCache, store: config.http_caching_object,
+                                  logger: logger,
+                                  shared_cache: false
+      end
       c.use RequestHeaders, config.api_token
       c.use config.api_token_middleware if config.api_token_middleware.present?
       c.request :json

data/lib/lws/apps/auth.rb

@@ -1,12 +1,12 @@
 #
-# Copyright © 2016 LeftClick B.V.
+# Copyright © 2016–2020 LeftClick B.V.
 #
 # This software is property of LeftClick 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 B.V. at:  Geldropseweg 8B, 5731 SG Mierlo, The
-# Netherlands, info@leftclick.eu, +31492-782120.
+# contact LeftClick B.V. at:  Schootense Dreef 20A, 5708 HZ Helmond, The
+# Netherlands, info@leftclick.eu, +3185-4444-004.
 
 
 # = The auth app module

data/lib/lws/apps/corporate_website.rb

@@ -1,12 +1,12 @@
 #
-# Copyright © 2016 LeftClick B.V.
+# Copyright © 2016–2020 LeftClick B.V.
 #
 # This software is property of LeftClick 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 B.V. at:  Geldropseweg 8B, 5731 SG Mierlo, The
-# Netherlands, info@leftclick.eu, +31492-782120.
+# contact LeftClick B.V. at:  Schootense Dreef 20A, 5708 HZ Helmond, The
+# Netherlands, info@leftclick.eu, +3185-4444-004.
 
 
 # = The corporate website app module

data/lib/lws/apps/digital_signage.rb

@@ -1,12 +1,12 @@
 #
-# Copyright © 2017 LeftClick B.V.
+# Copyright © 2016–2020 LeftClick B.V.
 #
 # This software is property of LeftClick 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 B.V. at:  Geldropseweg 8B, 5731 SG Mierlo, The
-# Netherlands, info@leftclick.eu, +31492-782120.
+# contact LeftClick B.V. at:  Schootense Dreef 20A, 5708 HZ Helmond, The
+# Netherlands, info@leftclick.eu, +3185-4444-004.
 
 
 # = The digital_signage app module
@@ -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
@@ -728,6 +761,19 @@ module LWS::DigitalSignage
     use_api LWS::DigitalSignage.api
     uri "layout/:layout_id/versions(/:id)"
 
+    # @!attribute archive_storage_id
+    #   @return [String, nil] sthe storage ID of the archive/layout pack of the
+    #     layout version
+    attribute :archive_storage_id
+
+    # @!attribute archive_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 archive/layout pack of the layout
+    #     version (if accessible)
+    attribute :archive_url
+
     # @!attribute elements
     #   @return [Array<Layout::Element>] the elements contained in the layout
     #     version
@@ -801,9 +847,9 @@ module LWS::DigitalSignage
     #   @return [Integer] the ID of the configuration of the player
     attribute :configuration_id
 
-    # @!attribute feedbacks
+    # @!attribute feedback
     #   @return [Hash{String=>String}] a mapping of player feedback key/values
-    attribute :feedbacks
+    attribute :feedback
 
     # @!attribute [r] health_percentage
     #   @return [Fixnum] the health of the player (percentage)
@@ -834,13 +880,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
@@ -855,6 +905,10 @@ module LWS::DigitalSignage
     #   @return [Array<Player::Component::Part>] the parts of the player
     has_many :parts, class_name: "LWS::DigitalSignage::Player::Component::Part"
 
+    # @!attribute recent_os
+    #   @return [Boolean] whether the OS of the player is recent
+    attribute :recent_os
+
     # @!attribute registration_locked
     #   @return [Boolean] whether registarion is locked for the player
     attribute :registration_locked
@@ -891,9 +945,14 @@ module LWS::DigitalSignage
     attribute :status
 
     # @!attribute status_reason [r]
-    #   @return [String] the reason for the current player status
+    #   @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"
@@ -1685,6 +1744,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"
@@ -1693,6 +1756,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
@@ -1711,13 +1787,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

@@ -1,12 +1,12 @@
 #
-# Copyright © 2016 LeftClick B.V.
+# Copyright © 2016–2020 LeftClick B.V.
 #
 # This software is property of LeftClick 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 B.V. at:  Geldropseweg 8B, 5731 SG Mierlo, The
-# Netherlands, info@leftclick.eu, +31492-782120.
+# contact LeftClick B.V. at:  Schootense Dreef 20A, 5708 HZ Helmond, The
+# Netherlands, info@leftclick.eu, +3185-4444-004.
 
 
 # = The generic app module
@@ -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
@@ -155,7 +157,11 @@ module LWS::Generic
     # @return [Object, nil] the digged up value or +nil+
     def dig(*attrs)
       attr = attrs.shift
-      value = send(attr)
+      value = begin
+                send(attr)
+              rescue NoMethodError
+                nil
+              end
       return nil if value.nil?
       return value if attrs.empty?
       raise TypeError, "#{value.class} does not have #dig method" unless value.respond_to? :dig
@@ -191,7 +197,7 @@ module LWS::Generic
 
   # = The storage class
   #
-  # This class can be used to upload files for this app module.
+  # This class can be used to download and upload files for this app module.
   class Storage
     # @!visibility private
     def self.use_api(api)
@@ -262,7 +268,7 @@ module LWS::Generic
       checksum = Digest::MD5.base64digest(data)
       body = { blob: { filename: filename,
                        content_type: content_type,
-                       byte_size: data.length,
+                       byte_size: data.bytesize,
                        checksum: checksum } }
       res = @as_connection.post do |req|
         req.url "rails/active_storage/direct_uploads"

data/lib/lws/apps/maps.rb

@@ -1,12 +1,12 @@
 #
-# Copyright © 2016 LeftClick B.V.
+# Copyright © 2016–2020 LeftClick B.V.
 #
 # This software is property of LeftClick 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 B.V. at:  Geldropseweg 8B, 5731 SG Mierlo, The
-# Netherlands, info@leftclick.eu, +31492-782120.
+# contact LeftClick B.V. at:  Schootense Dreef 20A, 5708 HZ Helmond, The
+# Netherlands, info@leftclick.eu, +3185-4444-004.
 
 
 # = The maps app module

data/lib/lws/apps/presence.rb

@@ -1,12 +1,12 @@
 #
-# Copyright © 2016 LeftClick B.V.
+# Copyright © 2016–2020 LeftClick B.V.
 #
 # This software is property of LeftClick 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 B.V. at:  Geldropseweg 8B, 5731 SG Mierlo, The
-# Netherlands, info@leftclick.eu, +31492-782120.
+# contact LeftClick B.V. at:  Schootense Dreef 20A, 5708 HZ Helmond, The
+# Netherlands, info@leftclick.eu, +3185-4444-004.
 
 
 # = The presence app module
@@ -43,10 +43,6 @@ module LWS::Presence
   class Appointment < LWS::Generic::Model
     use_api LWS::Presence.api
 
-    # @!attribute title
-    #   @return [String] the title of the appointment
-    attribute :title
-
     # @!attribute datetime_end
     #   @return [String] the timestamp of the end of the appointment
     attribute :datetime_end
@@ -72,17 +68,21 @@ module LWS::Presence
     attribute :location_id
 
     # @!attribute organiser
-    #   @return [Person] the origaniser of the appointment
+    #   @return [Person] the organiser of the appointment
     belongs_to :organiser, class_name: "LWS::Presence::Person"
 
     # @!attribute organiser_id
-    #   @return [Fixnum] the ID of the origaniser of the appointment
+    #   @return [Fixnum] the ID of the organiser of the appointment
     attribute :organiser_id
 
     # @!attribute people
     #   @return [Array<Person>] the people associated with the appointment
     has_many :people
 
+    # @!attribute title
+    #   @return [String] the title of the appointment
+    attribute :title
+
     # @!attribute uuid
     #   @return [String] the UUID of the location
     attribute :uuid
@@ -439,6 +439,10 @@ module LWS::Presence
   class Person < LWS::Generic::Model
     use_api LWS::Presence.api
 
+    # @!attribute address
+    #   @return [String, nil] the address of the person
+    attribute :address
+
     # @!attribute appointments
     #   @return [Array<Appointment>] the appointments involving the person
     has_many :appointments
@@ -454,6 +458,18 @@ module LWS::Presence
     #   @return [String, nil] the URL of the avatar of the person
     attribute :avatar_url
 
+    # @!attribute birthdate
+    #   @return [String, nil] the birthdate of the person
+    attribute :birthdate
+
+    # @!attribute city
+    #   @return [String, nil] the city of the person
+    attribute :city
+
+    # @!attribute country
+    #   @return [String, nil] the country of the person
+    attribute :country
+
     # @!attribute company
     #   @return [LWS::Auth::Company] the company the person belongs to
     belongs_to :company, class_name: "LWS::Auth::Company"
@@ -595,12 +611,24 @@ module LWS::Presence
     #   @return ["public", "private"] if a person should be protected by not
     #     showing critical information
     attribute :visibility
+
+    # @!attribute zip_code
+    #   @return [String, nil] the zip code of the person
+    attribute :zip_code
   end
 
   # = The reader class
   class Reader < LWS::Generic::Model
     use_api LWS::Presence.api
 
+    # @!attribute company
+    #   @return [LWS::Auth::Company] the company the reader belongs to
+    belongs_to :company, class_name: "LWS::Auth::Company"
+
+    # @!attribute company_id
+    #   @return [Integer] the ID of the company the reader belongs to
+    attribute :company_id
+
     # @!attribute gateway
     #   @return [Integer] the (32-bit) LCIO gateway ID of the reader
     attribute :gateway
@@ -613,9 +641,17 @@ module LWS::Presence
     #   @return [Integer] the ID of the location of the reader
     attribute :location_id
 
+    # @!attribute name
+    #   @return [String] the name of the reader
+    attribute :name
+
     # @!attribute node
     #   @return [Integer] the (8-bit) LCIO gateway node number of the reader
     attribute :node
+
+    # @!attribute serial_number
+    #   @return [String] the serial number of the reader
+    attribute :serial_number
   end
 
   # (see Generic::Storage)