lws 7.2.1 → 7.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6deffc4e78a47854d29873d8fc9a28362613690de1c942ae8eed2c5e83e937ca
-  data.tar.gz: a1986c2225a9f172a12cacc6a37d00a19458cbe396212a3281cb74c7901db850
+  metadata.gz: 7adfefa3011145091ec6c1bbcf5c729159e25785e6ed08a4d0a2016b3fee39da
+  data.tar.gz: 7a36e1b6055974e4694c90305a92780b53083070f7f4d68f4b60c3e0415d80b3
 SHA512:
-  metadata.gz: 3e8856e550c55c227c1671a42573f60044a7bee2e16be6a4f35f5e954cd2b37289a8ee4eee225894d5073e82cb37ee0111bd29c464ccad8c36b3872a0698eacf
-  data.tar.gz: c3e1c5f33253614acf54842796ccb4c9b3b532b4f172d22c7f5f0456056425c15f785a8df29db2af5eb80828bcd76ae3bf7131d74cff967702ad350b40f78656
+  metadata.gz: c9a678afd13b84a45b5806fe6b23cd62cd6fb168f9bb6ea3847a920e0f0ede050cf39ba2af2c19ec07adaeeeca8d67058fc74f786c20ba7a08a1a44207cc3cfa
+  data.tar.gz: 3326e671e49b61f88e12a98881c8339d3e0f13a2c76079cf957910b197af85078a35d065130694d73b91f295b2ae61c137878450ce05f71549ab48629605ffb1

data/bin/lwsconsole

@@ -36,7 +36,7 @@ EOB
     @options[:debug] = debug
   end
   opts.on("-e", "--environment=ENV", "select the LWS environment (default: production)") do |env|
-    @options[:environment] = env.to_sym
+    @options[:environment] = env
   end
   opts.on("-t", "--token=TOKEN", "the LWS API token necessary to gain access") do |token|
     @options[:token] = token
@@ -80,6 +80,7 @@ begin
   LWS.setup do |config|
     config.api_token = @options[:token] if @options[:token]
     config.endpoints = @endpoints
+    config.http_caching = true
     config.http_debug = @options[:debug]
     config.json_debug = @options[:debug]
     config.logger = logger

data/lib/lws.rb

@@ -8,7 +8,6 @@
 # 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"
@@ -81,7 +80,7 @@ module LWS
 
     # Override the environment if needed
     if ENV["LC_LWS_ENV"].present?
-      @@config.environment = ENV["LC_LWS_ENV"].to_sym
+      @@config.environment = ENV["LC_LWS_ENV"]
     end
 
     # Override the API token if needed (and no custom API token middleware
@@ -112,7 +111,7 @@ module LWS
   # @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|
+    api = Faraday.new(url: api_url, proxy: config.proxy) do |c|
       # Request
       if config.caching_object
         c.use FaradayMiddleware::Caching, config.caching_object

data/lib/lws/apps/auth.rb

@@ -14,18 +14,16 @@ module LWS::Auth
 
   # :nocov:
   unless defined? ENDPOINT
-    # The API endpoint for the auth app
+    # @!method self.endpoint
+    #   @return [String] the actual API endpoint used to reach the app
+
+    # The API endpoint environment mapping for the Auth app
     ENDPOINT = { production: "https://leftclick.cloud/" ,
                  development: "https://dev.leftclick.cloud/" }
   end
   # :nocov:
 
-  # @!visibility private
-  class << self
-    attr_accessor :api
-  end
-  @api = LWS.setup_api(LWS.config.endpoints[:auth] ||
-                       ENDPOINT[LWS.config.environment])
+  include LWS::Generic
 
   ### Generic classes
 

data/lib/lws/apps/corporate_website.rb

@@ -14,17 +14,16 @@ module LWS::CorporateWebsite
 
   # :nocov:
   unless defined? ENDPOINT
-    # The API endpoint for the corporate website app
+    # @!method self.endpoint
+    #   @return [String] the actual API endpoint used to reach the app
+
+    # The API endpoint environment mapping for the Corporate Website app
     ENDPOINT = { production: "https://www.leftclick.cloud/",
                  development: "https://www-dev.leftclick.cloud/" }
   end
   # :nocov:
 
-  # @!visibility private
-  def self.api
-    LWS.setup_api(LWS.config.endpoints[:corporate_website] ||
-                  ENDPOINT[LWS.config.environment])
-  end
+  include LWS::Generic
 
   ### Generic classes
 

data/lib/lws/apps/digital_signage.rb

@@ -14,17 +14,16 @@ module LWS::DigitalSignage
 
   # :nocov:
   unless defined? ENDPOINT
-    # The API endpoint for the digital signage app
+    # @!method self.endpoint
+    #   @return [String] the actual endpoint used to reach the app
+
+    # The API endpoint environment mapping for the Digital Signage app
     ENDPOINT = { production: "https://cm.leftclick.cloud/" ,
                  development: "https://cm-dev.leftclick.cloud/" }
   end
   # :nocov:
 
-  # @!visibility private
-  def self.api
-    LWS.setup_api(LWS.config.endpoints[:digital_signage] ||
-                  ENDPOINT[LWS.config.environment])
-  end
+  include LWS::Generic
 
   ### Generic classes
 
@@ -653,6 +652,12 @@ module LWS::DigitalSignage
     #    of the layout element
     has_many :customizables, class_name: "LWS::DigitalSignage::Layout::Element::Customizable"
 
+    # @!attribute definition
+    #   @note This attribute is only available if the token is of an account
+    #     with sysadmin permissions
+    #   @return [Hash] the (plugin) component definition of the layout element
+    attribute :definition
+
     # @!attribute index
     #   @return [Integer, nil] the index of the element within the list of
     #     layout elements of the associated layout version
@@ -768,8 +773,10 @@ module LWS::DigitalSignage
 
     # @!attribute archive_url
     #   @note
-    #     To be able retrieve this, the token needs to be passed via +X-Token+
-    #     in the HTTP request headers!
+    #     To be able retrieve the archive, the token needs to be passed via
+    #     +X-Token+ in the HTTP request headers!
+    #   @note This attribute is only available if the token is of an account
+    #     with sysadmin permissions
     #   @return [String, nil] the URL of the archive/layout pack of the layout
     #     version (if accessible)
     attribute :archive_url

data/lib/lws/apps/generic.rb

@@ -14,6 +14,25 @@
 # This module contains classes that are present in all applications.
 module LWS::Generic
 
+  def self.included(app_mod)
+    app_mod.module_eval do |mod|
+      # Set up the API using the configured or default endpoint for the current
+      # environment.
+      endpoints = mod.const_get(:ENDPOINT)
+      app_name = mod.name.demodulize.underscore.to_sym
+      @api = LWS.setup_api(LWS.config.endpoints[app_name] ||
+                           endpoints[LWS.config.environment])
+
+      def self.api
+        @api
+      end
+
+      def self.endpoint
+        @api.url_prefix.to_s
+      end
+    end
+  end
+
   # = The generic model class
   #
   # This model forms the base for all LWS models.
@@ -203,11 +222,13 @@ module LWS::Generic
     def self.use_api(api)
       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|
+      # An API connection to Active Storage (with JSON request/response, but
+      # 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?
 
         # Response
         c.use LWS::JSONLogger, config.logger if config.json_debug
@@ -223,7 +244,7 @@ module LWS::Generic
 
       # 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|
+      @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

data/lib/lws/apps/maps.rb

@@ -14,17 +14,16 @@ module LWS::Maps
 
   # :nocov:
   unless defined? ENDPOINT
-    # The API endpoint for the map app
+    # @!method self.endpoint
+    #   @return [String] the actual API endpoint used to reach the app
+
+    # The API endpoint environment mapping for the Maps app
     ENDPOINT = { production: "https://maps.leftclick.cloud/",
                  development: "https://maps-dev.leftclick.cloud/" }
   end
   # :nocov:
 
-  # @!visibility private
-  def self.api
-    LWS.setup_api(LWS.config.endpoints[:maps] ||
-                  ENDPOINT[LWS.config.environment])
-  end
+  include LWS::Generic
 
   ### Generic classes
 

data/lib/lws/apps/presence.rb

@@ -14,17 +14,16 @@ module LWS::Presence
 
   # :nocov:
   unless defined? ENDPOINT
-    # The API endpoint for the presence app
+    # @!method self.endpoint
+    #   @return [String] the actual API endpoint used to reach the app
+
+    # The API endpoint environment mapping for the Presence app
     ENDPOINT = { production: "https://presence.leftclick.cloud/",
                  development: "https://presence-dev.leftclick.cloud/" }
   end
   # :nocov:
 
-  # @!visibility private
-  def self.api
-    LWS.setup_api(LWS.config.endpoints[:presence] ||
-                  ENDPOINT[LWS.config.environment])
-  end
+  include LWS::Generic
 
   ### Generic classes
 
@@ -84,7 +83,7 @@ module LWS::Presence
     attribute :title
 
     # @!attribute uuid
-    #   @return [String] the UUID of the location
+    #   @return [String] the UUID of the appointment
     attribute :uuid
   end
 
@@ -174,11 +173,11 @@ module LWS::Presence
     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
+    #   @return ["available", "maintenance_cleaning", "maintenance_technical",
+    #     "reserved", "unavailable", "permanent_available",
+    #     "permanent_maintenance_cleaning", "permanent_maintenance_technical",
+    #     "permanent_reserved", "permanent_unavailable", nil] the status to set
+    #     the location to when someone checks out
     attribute :checkout_alter_status
 
     # @!attribute checkout_location
@@ -216,6 +215,10 @@ module LWS::Presence
     #   @return [String, nil] the URL of the image of the location
     attribute :image_url
 
+    # @!attribute import_ref
+    #   @return [String, nil] reference of the location in the remote database
+    attribute :import_ref
+
     # @!attribute journals
     #   @return [Array<Journal>] the journal (entries) associated with the location
     has_many :journals, class: "LWS::Presence::Journal"
@@ -285,10 +288,11 @@ module LWS::Presence
     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
+    #   @return ["available", "maintenance_cleaning",
+    #     "maintenance_technical",  "reserved", "unavailable",
+    #     "permanent_available", "permanent_maintenance_cleaning",
+    #     "permanent_maintenance_technical", "permanent_reserved",
+    #     "permanent_unavailable" ] the status of the location
     attribute :status
 
     # @!attribute time_zone
@@ -503,8 +507,7 @@ module LWS::Presence
     attribute :extra_info
 
     # @!attribute import_ref
-    #   @return [String, nil] reference for storing the uid of the remote
-    #     database
+    #   @return [String, nil] reference of the person in the remote database
     attribute :import_ref
 
     # @!attribute kind

data/lib/lws/apps/resource.rb

@@ -14,17 +14,16 @@ module LWS::Resource
 
   # :nocov:
   unless defined? ENDPOINT
-    # The API endpoint for the resource app
+    # @!method self.endpoint
+    #   @return [String] the actual API endpoint used to reach the app
+
+    # The API endpoint environment mapping for the Resource app
     ENDPOINT = { production: "https://resource.leftclick.cloud/",
                  development: "https://resource-dev.leftclick.cloud/" }
   end
   # :nocov:
 
-  # @!visibility private
-  def self.api
-    LWS.setup_api(LWS.config.endpoints[:resource] ||
-                  ENDPOINT[LWS.config.environment])
-  end
+  include LWS::Generic
 
   ### Generic classes
 

data/lib/lws/apps/ticket.rb

@@ -14,17 +14,16 @@ module LWS::Ticket
 
   # :nocov:
   unless defined? ENDPOINT
-    # The API endpoint for the ticket app
+    # @!method self.endpoint
+    #   @return [String] the actual API endpoint used to reach the app
+
+    # The API endpoint environment mapping for the Ticket app
     ENDPOINT = { production: "https://ticket.leftclick.cloud/",
                  development: "https://ticket-dev.leftclick.cloud/" }
   end
   # :nocov:
 
-  # @!visibility private
-  def self.api
-    LWS.setup_api(LWS.config.endpoints[:ticket] ||
-                  ENDPOINT[LWS.config.environment])
-  end
+  include LWS::Generic
 
   ### Generic classes
 

data/lib/lws/config.rb

@@ -8,7 +8,6 @@
 # contact LeftClick B.V. at:  Schootense Dreef 20A, 5708 HZ Helmond, The
 # Netherlands, info@leftclick.eu, +3185-4444-004.
 
-
 module LWS
 
   # = The LWS API configuration class
@@ -20,7 +19,9 @@ module LWS
   #   configured for the library to work properly!
   class Config < Hashie::Dash
     # The list of properties that can be set using a config file.
-    VALID_FILE_PROPERTIES = [:api_token, :endpoints, :http_debug, :http_debug_headers, :json_debug]
+    VALID_FILE_PROPERTIES =
+      [:api_token, :endpoints, :environment, :http_debug, :http_debug_headers,
+       :json_debug, :proxy]
 
     #@!attribute api_token
     #  @return [String, nil] the API token necessary to gain access
@@ -47,7 +48,7 @@ module LWS
 
     #@!attribute http_caching
     #  @return [Boolean] whether HTTP caching is enabled
-    property :http_caching, default: true
+    property :http_caching, default: false
 
     #@!attribute http_caching_object
     #  @return [#read, #write, #delete] an object that caches results
@@ -76,13 +77,42 @@ module LWS
     #    (Rails logger, Logger, etc.)
     property :logger
 
+    #@!attribute proxy
+    #  When passing a Hash, it should at least contain +:uri+ as key with
+    #  a String or URI as value and optionally the +:user+ and +:password+
+    #  keys with appropriate values.
+    #  @return [Hash, String, URI] the proxy configuration, either as URL or
+    #    as a Hash
+    property :proxy
+
     #@!attribute stubbing
     #  @return [String] the path to a directory with stubbing fixtures
     #    (setting this enables the default stubs)
     property :stubbing
 
-    # Supplements the configuration with settings from a config file.
+    # Sets the environment for the config.
+    #
+    # The provided environment can be a string in short and long format as well
+    # as a symbol.
+    #
+    # @param new_env [Symbol, String] the new environment to use
+    # @return [Symbol] the new environment
+    # @raise when an invalid environment is provided
+    def environment=(new_env)
+      real_env =
+        case new_env
+        when "prod", "production", :prod, :production
+          :production
+        when "dev", "development", :dev, :development
+          :development
+        else
+          raise "unsupported environment: #{new_env}"
+        end
+      self[:environment] = real_env
+    end
 
+    # Supplements the configuration with settings from a config file.
+    #
     # The configuration file has a section per environment that indicates
     # per property what to use if it is unset.
     #
@@ -100,9 +130,10 @@ module LWS
     # an environment key that selects the default environment (unless
     # overriden by the +LC_LWS_ENV+ environment variable).
     #
-    # @example A elaborate configuration that sets the development environment as default, enables debugging and overrides an endpoint
+    # @example A elaborate configuration that sets the proxy and the development environment as default, enables debugging and overrides an endpoint
     #   default:
     #     environment: "development"
+    #     proxy: "http://proxyserver:8080"
     #
     #   production:
     #     api_token: "my-prod-api-token"
@@ -123,12 +154,13 @@ module LWS
     def load_config_file(config_file, force_environment = nil)
       return false unless File.exist? config_file
       config_data = YAML.load_file(config_file)
-      environment = force_environment ||
-                    ENV["LC_LWS_ENV"] ||
-                    config_data.dig("default", "environment") ||
-                    self.environment
-      self.environment = environment.to_sym
-      config = config_data[environment.to_s] || {}
+      default_config = config_data["default"] || {}
+
+      self.environment = force_environment ||
+                         ENV["LC_LWS_ENV"] ||
+                         config_data.dig("default", "environment") ||
+                         self.environment
+      config = default_config.merge(config_data[self.environment.to_s] || {})
 
       config.each_pair do |key, value|
         unless VALID_FILE_PROPERTIES.include? key.to_sym

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.2.1".freeze
+  VERSION = "7.3.0".freeze
 
 end

data/test/config/full.yml

@@ -1,6 +1,7 @@
 ---
 default:
   environment: development
+  proxy: http://user:password@proxyserver:8080
 
 development:
   api_token: "dev-token"

data/test/digital_signage_test.rb

@@ -116,7 +116,7 @@ class TestDigitalSignageChannelTimeSchedule < MiniTest::Test
   include LWS::DigitalSignage
 
   def setup
-    @channel_time_schedule = Channel::TimeSchedule.all.first
+    @channel_time_schedule = Channel::TimeSchedule.find(1)
   end
 
   def test_valid
@@ -137,7 +137,7 @@ class TestDigitalSignageChannelTimeScheduleDay < MiniTest::Test
   include LWS::DigitalSignage
 
   def setup
-    @channel_time_schedule = Channel::TimeSchedule.all.first
+    @channel_time_schedule = Channel::TimeSchedule.find(1)
     # Time schedule days only exist as child objects of a time schedule
     @channel_time_schedule_day = @channel_time_schedule.days.first
   end

data/test/http_caching_test.rb

@@ -44,6 +44,7 @@ class TestHTTPCaching < MiniTest::Test
     # Redo the LWS setup with an HTTP caching object
     LWS.setup do |config|
       config.api_token = ENV["LC_LWS_TEST_TOKEN"]
+      config.http_caching = true
       config.http_caching_object = @cache_mock
       if ENV["LC_LWS_TEST_DEBUG"].present?
         config.http_debug = true

data/test/setup_test.rb

@@ -8,7 +8,6 @@
 # contact LeftClick B.V. at:  Schootense Dreef 20A, 5708 HZ Helmond, The
 # Netherlands, info@leftclick.eu, +3185-4444-004.
 
-
 require "test_helper"
 
 class TestSetup < MiniTest::Test
@@ -24,7 +23,7 @@ class TestSetup < MiniTest::Test
 
   def test_cannot_leave_out_api_token
     assert_raises do
-      LWS.setup { }
+      LWS.setup {}
     end
   end
 
@@ -47,6 +46,26 @@ class TestSetup < MiniTest::Test
     assert_equal("test-token", LWS.config.api_token)
   end
 
+  def test_environment_writer
+    LWS.config.environment = "prod"
+    assert_equal(:production, LWS.config.environment)
+    LWS.config.environment = "production"
+    assert_equal(:production, LWS.config.environment)
+    LWS.config.environment = :production
+    assert_equal(:production, LWS.config.environment)
+
+    LWS.config.environment = "dev"
+    assert_equal(:development, LWS.config.environment)
+    LWS.config.environment = "development"
+    assert_equal(:development, LWS.config.environment)
+    LWS.config.environment = :development
+    assert_equal(:development, LWS.config.environment)
+
+    assert_raises do
+      LWS.config.environment = "doesnotexist"
+    end
+  end
+
   def test_http_logging_without_logger
     reconfigure(logger: nil,
                 http_debug: true,
@@ -112,6 +131,7 @@ 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)
+    assert_equal("http://user:password@proxyserver:8080", LWS.config.proxy)
 
     with_env("LC_LWS_ENV" => "production") do
       reconfigure do |config|
@@ -128,4 +148,29 @@ class TestSetup < MiniTest::Test
     assert_equal(:development, LWS.config.environment)
   end
 
+  def test_proxy
+    proxy_url = "http://user:password@proxyserver:8080"
+    reconfigure do |config|
+      config.proxy = proxy_url
+    end
+
+    assert_equal(proxy_url, LWS.config.proxy)
+    assert_equal("http://user:password@proxyserver:8080", LWS::Auth.api.proxy.uri.to_s)
+    assert_equal("user", LWS::Auth.api.proxy.user)
+    assert_equal("password", LWS::Auth.api.proxy.password)
+
+    proxy_options =
+      { uri: Addressable::URI.parse("http://proxyserver:8080"),
+        user: "user",
+        password: "password" }
+    reconfigure do |config|
+      config.proxy = proxy_options
+    end
+
+    assert_equal(proxy_options, LWS.config.proxy)
+    assert_equal("http://proxyserver:8080", LWS::Auth.api.proxy.uri.to_s)
+    assert_equal("user", LWS::Auth.api.proxy.user)
+    assert_equal("password", LWS::Auth.api.proxy.password)
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lws
 version: !ruby/object:Gem::Version
-  version: 7.2.1
+  version: 7.3.0
 platform: ruby
 authors:
 - LeftClick B.V.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-29 00:00:00.000000000 Z
+date: 2021-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday-http-cache
@@ -33,7 +33,7 @@ dependencies:
         version: 0.10.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -43,7 +43,7 @@ dependencies:
         version: 0.10.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
@@ -140,14 +140,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement