lws 6.1.3 → 6.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6267aca741594637c3e7b0ddae082ac3cc98b41
-  data.tar.gz: b7eb1f7e0125fe0cbc5684f571090f90b81fe99b
+  metadata.gz: f30071c15667079a8cf84888f5259e3ead55071c
+  data.tar.gz: e85e421087a695a3f37c95ff07f5a570b79a380a
 SHA512:
-  metadata.gz: c8bab2ce1b6a0b03332e5e159ddbd9adf134ae386e0886bed568020b8b02ac919fb2c3c7d75692bd67e927805828a5aecc3db02a9eca125732de8d207e957f65
-  data.tar.gz: c4e2ebb8bd41a53c6fee1df9cdba2ab89c4363a60a0ae91496d57fe050eba5c189f6dc512c442b1a51cfc5122bc562551fdbe0ad12f82e7b51de7b6620d5120a
+  metadata.gz: b8422afa62c6f038824aa10d0c92a41b7c43ba516ee4e8684f480e5cfb6efa0bbae61ff1ee9e8c85edb8c2a6b5070c28d484601824828c7aecc537624120cbc9
+  data.tar.gz: 8ff70bddabe627aa3e4f14f5f5562ffee150aeb936322f3af460e73e5601598a9caba77087ba1800ae613dce0b2e8584dfcee65763bd31e1fcf8d6e4bf7c4c13

data/CHANGELOG.md

@@ -4,6 +4,16 @@ 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.4
+
+* Fix LWS Console environment command-line parameter not overriding the config
+* Print LWS setup on LWS Console start
+
+### Apps
+
+* Add some fields to the DigitalSignage app (closes: #12001)
+* Fix some relations in the Auth app (closes: #12026)
+
 ## v6.1.3
 
 * Fix `#find` on has many-associations not working

data/bin/lwsconsole

@@ -16,6 +16,7 @@ USER_CONFIG_FILE = "#{ENV['HOME']}/.config/LeftClick/lws.yml"
 
 # Parse the command-line arguments
 PROG_NAME = File.basename($0)
+APP_NAME = "LWS Console"
 @options = {}
 opt_parser = OptionParser.new do |opts|
   opts.banner = <<EOB
@@ -45,7 +46,7 @@ EOB
     exit
   end
   opts.on("--version", "display the LWS library version and exit") do
-    puts "LWS Console v#{LWS::VERSION}"
+    puts "#{APP_NAME} v#{LWS::VERSION}"
     exit
   end
 end
@@ -78,7 +79,6 @@ logger.formatter =
 begin
   LWS.setup do |config|
     config.api_token = @options[:token] if @options[:token]
-    config.environment = @options[:environment] if @options[:environment]
     config.endpoints = @endpoints
     config.http_debug = @options[:debug]
     config.json_debug = @options[:debug]
@@ -92,6 +92,8 @@ begin
       config.load_config_file(GLOBAL_CONFIG_FILE)
       config.load_config_file(USER_CONFIG_FILE)
     end
+
+    config.environment = @options[:environment] if @options[:environment]
   end
   if @options[:app]
     @app_module = LWS.app_module(@options[:app].downcase)
@@ -135,5 +137,27 @@ 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
 
+# Print an LWS setup summary
+puts "#{APP_NAME} v#{LWS::VERSION} started!"
+puts
+puts "- Environment:  #{LWS.config.environment}"
+puts "- API token:    #{LWS.config.api_token[0...-4].gsub(/\w/, '*')}#{LWS.config.api_token[-4..-1]}"
+if @app_module
+  puts "- App endpoint: #{@app_module.api.url_prefix}"
+end
+debug_outputs = []
+if LWS.config.http_debug
+  if LWS.config.http_debug_headers
+    debug_outputs << "HTTP (with headers)"
+  else
+    debug_outputs << "HTTP"
+  end
+end
+debug_outputs << "JSON" if LWS.config.json_debug
+unless debug_outputs.present?
+  puts "- Debug output: #{debug_outputs.join(', ')}"
+end
+puts
+
 # Use the LWS module or the selected app module as the default namespace
 (@app_module || LWS).pry

data/lib/lws/apps/auth.rb

@@ -76,7 +76,9 @@ module LWS::Auth
 
     # @!attribute start_app
     #   @return [App, nil] the app to start with/open when logging in
-    belongs_to :start_app, class_name: "LWS::Auth::App"
+    belongs_to :start_app, class_name: "LWS::Auth::App",
+                           foreign_key: :start_app_id,
+                           uri: "apps/:id"
 
     # @!attribute start_app_id
     #   @return [Fixnum, nil] the ID of the app to start with/open when logging in
@@ -196,7 +198,7 @@ module LWS::Auth
 
     # @!attribute contracts
     #   @return [Array<Contract>] the contracts of the company
-    has_many :contracts
+    has_many :contracts, uri: "companies/:company_id/contracts/(:id)"
 
     # @!attribute country
     #   @return [String] the country of the company
@@ -210,7 +212,7 @@ module LWS::Auth
 
     # @!attribute licenses
     #   @return [Array<License>] the licenses of the company
-    has_many :licenses
+    has_many :licenses, uri: "companies/:company_id/licenses/(:id)"
 
     # @!attribute name
     #   @return [String] the name of the company
@@ -240,7 +242,7 @@ module LWS::Auth
     # @!attribute usage_reports
     #   @return [Array<UsageReport>] the usage reports available/generated
     #     for the company
-    has_many :usage_reports, uri: "company/:company_id/reports/(:id)"
+    has_many :usage_reports, uri: "companies/:company_id/reports/(:id)"
 
     # @!attribute uuid
     #   @return [String] the UUID of the company
@@ -263,6 +265,7 @@ module LWS::Auth
   # = The contract class
   class Contract < LWS::Generic::Model
     use_api LWS::Auth.api
+    uri "companies/:company_id/contracts/(:id)"
 
     # @!attribute id [r]
     #   @return [Fixnum] the (unique) ID of the contract
@@ -333,6 +336,7 @@ module LWS::Auth
   # = The license class
   class License < LWS::Generic::Model
     use_api LWS::Auth.api
+    uri "companies/:company_id/licenses/(:id)"
 
     # @!attribute id [r]
     #   @return [Fixnum] the (unique) ID of the license
@@ -465,6 +469,7 @@ module LWS::Auth
   # = The usage report class
   class UsageReport < LWS::Generic::Model
     use_api LWS::Auth.api
+    uri "companies/:company_id/reports/(:id)"
 
     # @!attribute id [r]
     #   @return [Fixnum] the (unique) ID of the usage report

data/lib/lws/apps/digital_signage.rb

@@ -43,6 +43,10 @@ module LWS::DigitalSignage
     #   @return [Fixnum] the (unique) ID of the channel
     attribute :id
 
+    # @!attribute bandwidth
+    #   @return [Fixnum] the bandwidth limit for the channel (bytes per second)
+    attribute :bandwidth
+
     # @!attribute company
     #   @return [LWS::Auth::Company] the company the channel belongs to
     belongs_to :company, class_name: "LWS::Auth::Company"
@@ -51,6 +55,10 @@ module LWS::DigitalSignage
     #   @return [Fixnum] the ID of the company the channel belongs to
     attribute :company_id
 
+    # @!attribute daily_reboot_time
+    #  @return [String] the daily reboot time of the channel
+    attribute :daily_reboot_time
+
     # @!attribute display
     #   @return [Display] the display of the channel
     belongs_to :display, class_name: "LWS::DigitalSignage::Display"
@@ -78,10 +86,19 @@ module LWS::DigitalSignage
     #     the channel
     attribute :orientation
 
+    # @!attribute persistent_connection
+    #   @return [Boolean] whether the channel is considered to have a persistent
+    #      network connection
+    attribute :persistent_connection
+
     # @!attribute players
     #   @return [Array<Player>] the players linked to the channel
     has_many :players, class_name: "LWS::DigitalSignage::Player"
 
+    # @!attribute remote_control
+    #   @return [Boolean] whether remote control is enabled for the channel
+    attribute :remote_control
+
     # @!attribute tags
     #   @return [Array<Channel::Tag>] the tags of the channel
     has_many :tags, class_name: "LWS::DigitalSignage::Channel::Tag"
@@ -104,6 +121,10 @@ module LWS::DigitalSignage
     #   @return [String] the time zone for the channel
     attribute :time_zone
 
+    # @!attribute volume
+    #   @return [Fixnum] the audio volume setting of the channel (percentage)
+    attribute :volume
+
     # @!attribute created_at [r]
     #   @return [String] the timestamp of when the channel was created
     attribute :created_at

data/lib/lws/config.rb

@@ -85,7 +85,7 @@ module LWS
     #
     # 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.
+    # 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:

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.3'.freeze
+  VERSION = '6.1.4'.freeze
 
 end

data/test/auth_test.rb

@@ -34,8 +34,7 @@ class TestAuthAccount < MiniTest::Test
     if @account.devices.present?
       assert_instance_of(Device, @account.devices.first)
     end
-    # FIXME: Doesn't work
-    #assert_instance_of(App, @account.start_app)
+    assert_instance_of(App, @account.start_app)
   end
 
 end
@@ -82,39 +81,36 @@ class TestAuthCompany < MiniTest::Test
     assert_instance_of(Account, @company.accounts.first)
     assert_instance_of(App, @company.apps.first)
     assert_instance_of(Account, @company.contact_person)
-    # FIXME: Doesn't work
-    #assert_instance_of(Contract, @company.contracts.first)
+    assert_instance_of(Contract, @company.contracts.first)
     assert_instance_of(License, @company.licenses.first)
     assert_instance_of(Company, @child_company.parent)
-    # FIXME: Doesn't work
-    #assert_instance_of(UsageReport, @company.usage_reports.first)
+    assert_instance_of(UsageReport, @company.usage_reports.first)
   end
 
 end
 
-# FIXME: Can't get a contract to test
-#class TestAuthContract < MiniTest::Test
-#
-#  include LWS::Auth
-#
-#  def setup
-#    @company = Company.find(1)
-#    # Contracts only exist as child objects of companies
-#    @contract = @company.contracts.first
-#  end
-#
-#  def test_valid
-#    refute_nil(@contract)
-#    assert_instance_of(Contract, @contract)
-#    refute_nil(@contract.id)
-#  end
-#
-#  def test_valid_associations
-#    assert_instance_of(Company, @contract.company)
-#    assert_equal(@company, @contract.company)
-#  end
-#
-#end
+class TestAuthContract < MiniTest::Test
+
+  include LWS::Auth
+
+  def setup
+    @company = Company.find(1)
+    # Contracts only exist as child objects of companies
+    @contract = @company.contracts.first
+  end
+
+  def test_valid
+    refute_nil(@contract)
+    assert_instance_of(Contract, @contract)
+    refute_nil(@contract.id)
+  end
+
+  def test_valid_associations
+    assert_instance_of(Company, @contract.company)
+    assert_equal(@company, @contract.company)
+  end
+
+end
 
 class TestAuthLicense < MiniTest::Test
 
@@ -170,25 +166,25 @@ class TestAuthToken < MiniTest::Test
 
 end
 
-# FIXME: Can't get a usage report to test
-#class TestAuthUsageReport < MiniTest::Test
-#
-#  include LWS::Auth
-#
-#  def setup
-#    @company = Company.find(1)
-#    @usage_report = @company.usage_reports.first
-#  end
-#
-#  def test_valid
-#    refute_nil(@usage_report)
-#    assert_instance_of(UsageReport, @usage_report)
-#    refute_nil(@usage_report.id)
-#  end
-#
-#  def test_valid_associations
-#    assert_instance_of(Company, @usage_report.company)
-#    assert_equal(@company, @usagee_report.company)
-#  end
-#
-#end
+class TestAuthUsageReport < MiniTest::Test
+
+  include LWS::Auth
+
+  def setup
+    @company = Company.find(1)
+    # Contracts only exist as child objects of companies
+    @usage_report = @company.usage_reports.first
+  end
+
+  def test_valid
+    refute_nil(@usage_report)
+    assert_instance_of(UsageReport, @usage_report)
+    refute_nil(@usage_report.id)
+  end
+
+  def test_valid_associations
+    assert_instance_of(Company, @usage_report.company)
+    assert_equal(@company, @usage_report.company)
+  end
+
+end

metadata

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