lws 7.2.4 → 7.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 215d80612cb5ad547181deadb4a61244b8a108c3e1b6a24e52b288c9dcddc507
-  data.tar.gz: '0892759a406c54e49087e7e84ac6a0b433144c936ca8b74e8e3ab0d23a652933'
+  metadata.gz: d062091468c34f7dfcdefce30fc76940eac3f9350200029ca6474e63a3264314
+  data.tar.gz: 0a3669c523669251467f169ca2a70980fb3bcdb43fb0e86e26eb4ee1df5da2f5
 SHA512:
-  metadata.gz: 76bb918ff504f80e6d7e65bce4eaa8a229cdbc9b6b52bced17aa600f87d1b5e1b5ab32adac0e28de00c0b0f1fa49d326962ceaeb80087aac8e5f82914915777e
-  data.tar.gz: e63b88135279e691f345911a249d46a56d20c90534f6759ba64a3830f7c7b3074b0a67bc1206f972637a8a3c3a12b69e221e82cb6464f6b42f16662168de8f99
+  metadata.gz: 37b19c793a36fbc741e3b6242d31229dd394cc7f54e281acf6ad686d7bccf6d332b168bb65f54d9d5cdbe336dd7a16df65b440dca9bca570c2893c1ff11d3d94
+  data.tar.gz: 430f4a6cb0a4b0b5441edbb185fc840c5606caae8f258ae4c0272c609294ca49a31693e8aaea0d521f5cbb7d4b38ccafe1c487b032052e93acfd8b296a76fbcd

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

data/lib/lws/apps/generic.rb

@@ -14,6 +14,26 @@
 # 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.
@@ -205,7 +225,7 @@ module LWS::Generic
 
       # An API connection to Active Storage (with JSON request/response, but
       # without caching).
-      @as_connection = Faraday.new(url: api.url_prefix) do |c|
+      @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
@@ -225,7 +245,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
 

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
@@ -76,6 +77,14 @@ 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)
@@ -121,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"
@@ -144,11 +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)
+      default_config = config_data["default"] || {}
+
       self.environment = force_environment ||
                          ENV["LC_LWS_ENV"] ||
                          config_data.dig("default", "environment") ||
                          self.environment
-      config = config_data[self.environment.to_s] || {}
+      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.4".freeze
+  VERSION = "7.2.5".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/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
@@ -132,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|
@@ -148,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.4
+  version: 7.2.5
 platform: ruby
 authors:
 - LeftClick B.V.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-11 00:00:00.000000000 Z
+date: 2021-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday-http-cache