lws 6.1.0 → 6.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2eb1ec948cd52f1f5c3610ac4c3fc04d0ee1c711
-  data.tar.gz: 6368649a24fa9016db6e9e0ca52b77528ad83df2
+  metadata.gz: 208979361cc45a960b3e244066fdbc66379585d8
+  data.tar.gz: f1745c97f3315d1a33d23d8e0e5dd760c7e09822
 SHA512:
-  metadata.gz: b669df0b60760d421f95d4994ff01d554758a40d54767982eb00705cbd988e2a10503200bd1eda281e94ddc3127bc303ede13c75c719e2c9575d0c9b1fd2a3cf
-  data.tar.gz: 0fd2381ff359b7be8e30c13622d663ccec20ab30e89404cb52127c29f2cb25a950deba303e04bfe6a9fe8a39d75a6385f0358b92630296599bd12d3bb46a64c8
+  metadata.gz: 203e6d4dca711def56ff2305e206334540a04d5d481cc6ed6c92d3a57a1f4a9e4ecc3149eba5b5c99a0c8b7218b4758a4ac36a48cf3107b5795efabe8593717c
+  data.tar.gz: f271a3e7dea0da2c2e791fe3d85df6d8cdbcccd231baf0ecd03ac65df38408436d6bde759cfa568e01b9d86e418b11f103e5bc4f664028623bbb4d57b3b8df5c

data/CHANGELOG.md

@@ -4,6 +4,13 @@ Up until v6.1.0, we used the standard Gem version numbering starting at v0.0.1.
 From v6.1.0 on the version will follow the API version of LWS in the major/minor
 part of te version.
 
+## v6.1.1
+
+* Support a global and user-specific config file for LWS console
+* Use a separate history and specific prompt for LWS console
+* Small documentation fixes
+* Speed up the tests
+
 ## v6.1.0
 
 * Switch to LWS/LeftClick platform release versions

data/bin/lwsconsole

@@ -10,6 +10,10 @@ require "optparse"
 require "pp"
 require "pry"
 
+# Defaults
+GLOBAL_CONFIG_FILE = "/etc/LeftClick/lws.yml"
+USER_CONFIG_FILE = "#{ENV['HOME']}/.config/LeftClick/lws.yml"
+
 # Parse the command-line arguments
 PROG_NAME = File.basename($0)
 @options = {}
@@ -24,6 +28,9 @@ EOB
   opts.on("-a", "--app=APP-NAME", "switch to a specific app") do |app|
     @options[:app] = app
   end
+  opts.on("-c", "--config=CFGFILE", "use a specific configuration file") do |cfg_file|
+    @options[:cfg_file] = cfg_file
+  end
   opts.on("-d", "--[no-]debug", "show HTTP and JSON debug information") do |debug|
     @options[:debug] = debug
   end
@@ -76,6 +83,15 @@ begin
     config.http_debug = @options[:debug]
     config.json_debug = @options[:debug]
     config.logger = logger
+
+    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)
+    else
+      config.load_config_file(GLOBAL_CONFIG_FILE)
+      config.load_config_file(USER_CONFIG_FILE)
+    end
   end
   if @options[:app]
     @app_module = LWS.app_module(@options[:app].downcase)
@@ -114,5 +130,10 @@ def reload!
   LWS.load_app_modules
 end
 
+# Set up Pry
+FileUtils.mkdir_p("#{ENV['HOME']}/.local/share/LeftClick")
+Pry.config.history.file = "#{ENV['HOME']}/.local/share/LeftClick/lws_history"
+Pry.config.prompt_name = PROG_NAME
+
 # Use the LWS module or the selected app module as the default namespace
 (@app_module || LWS).pry

data/lib/lws/apps/digital_signage.rb

@@ -1454,7 +1454,8 @@ module LWS::DigitalSignage
     attribute :from_version_id
 
     # @!attribute log
-    #   @return [String] the log of the player OS package version change
+    #   @return [String, nil] the log of the player OS package version change
+    #     (can be +nil+ if {#to_version} is +nil+)
     attribute :log
 
     # @!attribute package

data/lib/lws/config.rb

@@ -19,6 +19,9 @@ module LWS
   # @note Either the API token or API token middleware needs to be
   #   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]
+
     #@!attribute api_token
     #  @return [String, nil] the API token necessary to gain access
     property :api_token
@@ -64,6 +67,73 @@ module LWS
     #  @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.
+
+    # The configuration file has a section per environment that indicates
+    # per property what to use if it is unset.
+    #
+    # Note that this is only done for a specific subset of of properties.
+    # See {VALID_FILE_PROPERTIES} for this subset!
+    #
+    # @example A simple configuration that sets the API token per environment
+    #   production:
+    #     api_token: "my-prod-api-token"
+    #
+    #   development:
+    #     api_token: "my-dev-api-token"
+    #
+    # The configuration file can optionally have a "default" section with
+    # 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
+    #   default:
+    #     environment: "development"
+    #
+    #   production:
+    #     api_token: "my-prod-api-token"
+    #     http_debug: false
+    #     json_debug: false
+    #
+    #   development:
+    #     api_token: "my-dev-api-token"
+    #     endpoints:
+    #       maps: http://maps.leftclick.cloud
+    #     http_debug: true
+    #     json_debug: true
+    #
+    # @return [Boolean] whether the config file was used
+    def load_config_file(config_file)
+      return false unless File.exist? config_file
+      config_data = YAML.load_file(config_file)
+      environment = ENV["LC_LWS_ENV"] ||
+                    config_data.dig("default", "environment") ||
+                    self.environment
+      self.environment = environment.to_sym
+      config = config_data[environment.to_s] || {}
+
+      config.each_pair do |key, value|
+        unless VALID_FILE_PROPERTIES.include? key.to_sym
+          raise "encountered an invalid config property \"#{key}\" " +
+                "in config file #{config_file}!"
+        end
+
+        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]
+        end
+      end
+      true
+    end
+
   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 = '6.1.0'
+  VERSION = '6.1.1'
 
 end

data/test/config/empty.yml

@@ -0,0 +1,2 @@
+---
+default: {}

data/test/config/endpoints.yml

@@ -0,0 +1,4 @@
+---
+development:
+  endpoints:
+    maps: http://maps.leftclick.cloud

data/test/config/full.yml

@@ -0,0 +1,15 @@
+---
+default:
+  environment: development
+
+development:
+  api_token: "dev-token"
+  endpoints:
+    maps: "http://maps.leftclick.cloud"
+  http_debug: true
+  http_debug_headers: true
+  json_debug: true
+
+production:
+  http_debug: false
+  json_debug: false

data/test/config/invalid.yml

@@ -0,0 +1,3 @@
+---
+development:
+  foo: bar

data/test/config/switch_env.yml

@@ -0,0 +1,3 @@
+---
+default:
+  environment: production

data/test/config/tokens.yml

@@ -0,0 +1,3 @@
+---
+development:
+  api_token: "dev-token"

data/test/presence_test.rb

@@ -16,7 +16,7 @@ class TestPresenceLocation < MiniTest::Test
   include LWS::Presence
 
   def setup
-    @location = Location.all.first
+    @location = Location.find(1)
   end
 
   def test_valid
@@ -38,7 +38,7 @@ class TestPresencePerson < MiniTest::Test
   include LWS::Presence
 
   def setup
-    @person = Person.all.first
+    @person = Person.find(1)
   end
 
   def test_valid

data/test/setup_test.rb

@@ -13,6 +13,10 @@ require "test_helper"
 
 class TestSetup < MiniTest::Test
 
+  def setup
+    @test_config_dir = File.expand_path("../config", __FILE__)
+  end
+
   def teardown
     # Restore the configuration
     reconfigure
@@ -65,4 +69,50 @@ class TestSetup < MiniTest::Test
     end
   end
 
+  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
+    assert_equal LWS.config, orig_config
+
+    reconfigure do |config|
+      refute config.load_config_file(File.join(@test_config_dir, "does_not_exist.yml"))
+    end
+
+    reconfigure do |config|
+      config.api_token = nil
+      assert config.load_config_file(File.join(@test_config_dir, "tokens.yml"))
+    end
+    assert_equal LWS.config.api_token, "dev-token"
+
+    reconfigure do |config|
+      assert config.load_config_file(File.join(@test_config_dir, "switch_env.yml"))
+    end
+    assert_equal LWS.config.environment, :production
+
+    reconfigure do |config|
+      assert config.load_config_file(File.join(@test_config_dir, "endpoints.yml"))
+    end
+    assert_equal LWS.config.endpoints, { maps: "http://maps.leftclick.cloud" }
+
+    assert_raises do
+      reconfigure do |config|
+        assert config.load_config_file(File.join(@test_config_dir, "invalid.yml"))
+      end
+    end
+
+    reconfigure do |config|
+      config.api_token = nil
+      assert config.load_config_file(File.join(@test_config_dir, "full.yml"))
+    end
+    assert_equal LWS.config.api_token, "dev-token"
+    assert_equal LWS.config.endpoints, { maps: "http://maps.leftclick.cloud" }
+    assert_equal LWS.config.environment, :development
+    assert_equal LWS.config.http_debug, true
+    assert_equal LWS.config.http_debug_headers, true
+    assert_equal LWS.config.json_debug, true
+  end
+
 end

data/test/test_helper.rb

@@ -43,7 +43,7 @@ Dir[File.expand_path("../support/**.rb", __FILE__)].each { |f| require f }
 
 raise "Test token not set" if ENV["LC_LWS_TEST_TOKEN"].blank?
 
-def reconfigure(options = {})
+def reconfigure(options = {}, &block)
   LWS.setup do |config|
     config.api_token = ENV["LC_LWS_TEST_TOKEN"]
     if ENV["LC_LWS_TEST_DEBUG"].present?
@@ -58,6 +58,9 @@ def reconfigure(options = {})
     options.each do |key, value|
       config[key] = value
     end
+
+    # Finally, yield the block
+    yield config if block_given?
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lws
 version: !ruby/object:Gem::Version
-  version: 6.1.0
+  version: 6.1.1
 platform: ruby
 authors:
 - LeftClick B.V.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-22 00:00:00.000000000 Z
+date: 2018-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
@@ -257,6 +257,12 @@ files:
 - test/api_token_middleware_test.rb
 - test/auth_test.rb
 - test/caching_test.rb
+- test/config/empty.yml
+- test/config/endpoints.yml
+- test/config/full.yml
+- test/config/invalid.yml
+- test/config/switch_env.yml
+- test/config/tokens.yml
 - test/corporate_website_test.rb
 - test/digital_signage_test.rb
 - test/fixtures/auth.yml
@@ -290,7 +296,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
 summary: LeftClick web services library for Ruby
@@ -298,6 +304,12 @@ test_files:
 - test/api_token_middleware_test.rb
 - test/auth_test.rb
 - test/caching_test.rb
+- test/config/empty.yml
+- test/config/endpoints.yml
+- test/config/full.yml
+- test/config/invalid.yml
+- test/config/switch_env.yml
+- test/config/tokens.yml
 - test/corporate_website_test.rb
 - test/digital_signage_test.rb
 - test/fixtures/auth.yml