lws 7.1.2 → 7.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6ddf096778ba5030a935df95f904a65776bbd8b2dd30602e3c9d912124fb5cd
-  data.tar.gz: 739154dc2c9598eef580f9a562cff9ddccde3a0828e985c55429ceed74f03a5d
+  metadata.gz: b61e005e4e0e7bf19e2d9299e5444e914c5aac6df6cfd3084cd63ff5fd75bb87
+  data.tar.gz: 0fa6b75fa04c5b9823052e79a74283fcb1de031ca3312cd921f942100cb32248
 SHA512:
-  metadata.gz: c6f4e39e00a7277ed012c6d4a2a846dae249edf892db185d17c5a62efa012902bc388ed4e652a26e25eb30ea07e208fbe4ef08b19671c750a0e3f33aa719f8a5
-  data.tar.gz: 696ae43f1ed90d4674365f86d63d411fc21544cce16ba250079e0bcefef1143c9d908c6e01b18773b006fa9a704e45ebc85795ff044c28948bf16fb79f4da042
+  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)
@@ -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

@@ -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
+    # @!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 +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
@@ -891,9 +928,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 +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"
@@ -1693,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
@@ -1711,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

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.1.2".freeze
+  VERSION = "7.1.3".freeze
 
 end

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
@@ -950,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
@@ -961,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/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

@@ -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|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lws
 version: !ruby/object:Gem::Version
-  version: 7.1.2
+  version: 7.1.3
 platform: ruby
 authors:
 - LeftClick B.V.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-07 00:00:00.000000000 Z
+date: 2020-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday_middleware