lws 6.1.1 → 6.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 208979361cc45a960b3e244066fdbc66379585d8
-  data.tar.gz: f1745c97f3315d1a33d23d8e0e5dd760c7e09822
+  metadata.gz: 6c28a47576f5116e961f09171fffaa9ce938ac66
+  data.tar.gz: 1da0aa547debc76bd41de01e5adf1a4c3f1c4e9c
 SHA512:
-  metadata.gz: 203e6d4dca711def56ff2305e206334540a04d5d481cc6ed6c92d3a57a1f4a9e4ecc3149eba5b5c99a0c8b7218b4758a4ac36a48cf3107b5795efabe8593717c
-  data.tar.gz: f271a3e7dea0da2c2e791fe3d85df6d8cdbcccd231baf0ecd03ac65df38408436d6bde759cfa568e01b9d86e418b11f103e5bc4f664028623bbb4d57b3b8df5c
+  metadata.gz: 427a6172d9968b9137ac68ae67be607ac5277dc2a961332e1dd8b48c3544d34996d4e91c4b465443fd0c858481413dd74ea61e2472c041f96e5c7a37deba112f
+  data.tar.gz: 165cba8de10e722a3786c9bedc032fb6f64f818b88da6940be9fde35837478c02b461d8e16cabedc46c747405724b3001c435f7f89be9e81d1c1b06d7b0c1cb9

data/.yardopts

@@ -0,0 +1,8 @@
+--hide-void-return
+--no-private
+--protected
+--readme README.md
+--title 'LeftClick Web Services Documentation'
+'lib/**/*.rb'
+-
+'*.md'

data/CHANGELOG.md

@@ -1,13 +1,23 @@
-# LWS Changelog
+# LeftClick Web Services Changelog
 
 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.2
+
+* Small tweaks to LWS Console
+* Add LWS Console documentation (in the README)
+* Documentation improvements
+
+### Development
+
+* Fix caching tests not tearing down the specific setup
+
 ## v6.1.1
 
-* Support a global and user-specific config file for LWS console
-* Use a separate history and specific prompt for LWS console
+* 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
 
@@ -19,9 +29,9 @@ part of te version.
 * Use JSON as the wire format for sending data to LWS
 * Switch to using our own exceptions (see LWS::Errors)
 * Add support for setting the LWS API token in the environment
-* Switch to Pry as the REPL used by the LWS console
-* Add commands to the LWS console to toggle debug options
-* Add option parsing and app/environment/debug mode selection to LWS console
+* Switch to Pry as the REPL used by the LWS Console
+* Add commands to the LWS Console to toggle debug options
+* Add option parsing and app/environment/debug mode selection to LWS Console
 
 ### Apps
 

data/README.md

@@ -83,3 +83,72 @@ The `LC_LWS_ENV` environment variable is supported to override the LWS
 environment.  Allowed values are "production" (default) and "development".
 The `LC_LWS_API_TOKEN` is supported to set the LWS API token default.
 This only works if a custom API token middleware is not used.
+
+## LWS Console
+
+This library comes with the program `lwsconsole`, which is a command-line
+tool that can be used to interactively use the library.  (This is similar
+to the Rails console.)  See `lwsconsole --help` for the supported
+command-line arguments.
+
+LWS Console will perform the setup for you and give you a prompt in the
+`LWS` module namespace or the module of an app if this is selected via the
+arguments.  It uses the production environment per default using the token
+provided by a command-line argument.  These defaults can be overriden using
+the configuration.  For example, to rename a map:
+
+```
+$ lwsconsole -t "my_token" -a maps
+[1] lwsconsole(LWS::Maps)> Map.all.map(&:name)
+=> ["Gebouw 1",
+"Gebouw 3"]
+[2] lwsconsole(LWS::Maps)> map = Map.find(2)
+=> #<LWS::Maps::Map(maps/(:id)) id: 2 name: "Gebouw 3" ... markers: []>
+[3] lwsconsole(LWS::Maps)> map.name = "Gebouw 2"
+"Gebouw 2"
+[4] lwsconsole(LWS::Maps)> map.save
+nil
+```
+
+Besides the API calls, LWS console supports a few commands to change its
+behaviour:
+
+* `http_debug true|false`: Toggles HTTP debugging for API calls
+* `http_debug_headers true|false`: Toggles logging of HTTP headers in the HTTP debug output
+* `json_debug true|false`: Toggles JSON debug output for API calls
+* `reload!`: Reloads all apps
+
+```
+[5] lwsconsole(LWS::Maps)> http_debug true
+true
+```
+
+LWS Console keeps a history of all calls and commands, use the command
+`history --all` to seem them.  Use the command `help` to see all other
+available commands (provided by Pry).
+
+### Configuration files
+
+LWS Console will look for the configuration files first in
+`/etc/LeftClick/lws.yml` and then `~/.config/LeftClick/lws.yml`; they are
+in the YAML format.
+
+The configuration file can set defaults per environment.  It is possible to
+set the API key, endpoints and debug modes.
+
+```yaml
+development:
+  api_token: "my_token"
+  endpoints:
+    maps: "https://maps.leftclick.cloud
+  http_debug: true
+  http_debug_headers: true
+  json_debug: true
+```
+
+To override the default environment, use the default section.  For example:
+
+```yaml
+default:
+  environment: "development"
+```

data/Rakefile

@@ -21,11 +21,7 @@ Rake::TestTask.new do |t|
   t.pattern = "test/*_test.rb"
 end
 
-YARD::Rake::YardocTask.new do |t|
-  t.files = ["lib/**/*.rb", "-", "README.md", "CHANGELOG.md"]
-  t.options = ["--no-private",
-               "--title", "LeftClick Web Services Documentation"]
-end
+YARD::Rake::YardocTask.new
 
 task doc: :yard
 

data/bin/lwsconsole

@@ -45,7 +45,7 @@ EOB
     exit
   end
   opts.on("--version", "display the LWS library version and exit") do
-    puts LWS::VERSION
+    puts "LWS Console v#{LWS::VERSION}"
     exit
   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.1'
+  VERSION = '6.1.2'
 
 end

data/test/auth_test.rb

@@ -152,7 +152,7 @@ class TestAuthToken < MiniTest::Test
     refute_nil(@token)
     assert_instance_of(Token, @token)
     refute_nil(@token.id)
-    assert_equal(@token.token, LWS.config.api_token)
+    assert_equal(LWS.config.api_token, @token.token)
   end
 
   def test_valid_associations

data/test/caching_test.rb

@@ -46,13 +46,18 @@ class TestCaching < MiniTest::Test
     end
   end
 
+  def teardown
+    # Restore the configuration
+    reconfigure
+  end
+
   def test_working_cache
     assert_nil(@cache_mock.last_read_key)
     assert_nil(@cache_mock.last_written_key)
     assert_nil(@cache_mock.last_written_value)
     config = LWS::Auth::Configuration.all.first
-    assert_equal(@cache_mock.last_read_key, "/configurations")
-    assert_equal(@cache_mock.last_written_key, "/configurations")
+    assert_equal("/configurations", @cache_mock.last_read_key)
+    assert_equal("/configurations", @cache_mock.last_written_key)
     refute_nil(@cache_mock.last_written_value)
   end
 

data/test/digital_signage_test.rb

@@ -420,7 +420,7 @@ class TestDigitalSignagePlayerFeedbackResult < MiniTest::Test
   # FIXME: Chained associations don't work yet in Spyke (#89)
   #def test_valid_associations
   #  assert_instance_of(Player, @player_feedback_result.player)
-  #  assert_equal(@player_feedback, @player_feedback_result.player)
+  #  assert_equal(@player, @player_feedback_result.player)
   #  assert_instance_of(Player::Feedback, @player_feedback_result.feedback)
   #  assert_equal(@player_feedback, @player_feedback_result.feedback)
   #end

data/test/generic_test.rb

@@ -28,7 +28,7 @@ class TestGenericConfiguration < MiniTest::Test
 
   def test_her_compatibility
     @configuration.assign_attributes("value" => "other_value")
-    assert_equal "other_value", @configuration.value
+    assert_equal("other_value", @configuration.value)
   end
 
   def test_lifecycle

data/test/maps_test.rb

@@ -50,7 +50,7 @@ class TestMapsMarker < MiniTest::Test
 
   def test_valid_map_associations
     assert_instance_of(Map, @marker.map)
-    assert_equal(@marker.map, @map)
+    assert_equal(@map, @marker.map)
   end
 
 end

data/test/setup_test.rb

@@ -32,19 +32,19 @@ class TestSetup < MiniTest::Test
     with_env("LC_LWS_ENV" => "production") do
       reconfigure
     end
-    assert_equal(LWS.config.environment, :production)
+    assert_equal(:production, LWS.config.environment)
 
     with_env("LC_LWS_ENV" => "production") do
       LWS.setup do |config|
         config.api_token = ENV["LC_LWS_TEST_TOKEN"]
       end
     end
-    assert_equal(LWS.config.environment, :production)
+    assert_equal(:production, LWS.config.environment)
 
     with_env("LC_LWS_API_TOKEN" => "test-token") do
       reconfigure
     end
-    assert_equal(LWS.config.api_token, "test-token")
+    assert_equal("test-token", LWS.config.api_token)
   end
 
   def test_http_logging_without_logger
@@ -75,7 +75,7 @@ class TestSetup < MiniTest::Test
     reconfigure do |config|
       assert config.load_config_file(File.join(@test_config_dir, "empty.yml"))
     end
-    assert_equal LWS.config, orig_config
+    assert_equal(orig_config, LWS.config)
 
     reconfigure do |config|
       refute config.load_config_file(File.join(@test_config_dir, "does_not_exist.yml"))
@@ -85,17 +85,17 @@ class TestSetup < MiniTest::Test
       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"
+    assert_equal("dev-token", LWS.config.api_token)
 
     reconfigure do |config|
       assert config.load_config_file(File.join(@test_config_dir, "switch_env.yml"))
     end
-    assert_equal LWS.config.environment, :production
+    assert_equal(:production, LWS.config.environment)
 
     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_equal({ maps: "http://maps.leftclick.cloud" }, LWS.config.endpoints)
 
     assert_raises do
       reconfigure do |config|
@@ -107,12 +107,12 @@ class TestSetup < MiniTest::Test
       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
+    assert_equal("dev-token", LWS.config.api_token)
+    assert_equal({ maps: "http://maps.leftclick.cloud" }, LWS.config.endpoints)
+    assert_equal(:development, LWS.config.environment)
+    assert_equal(true, LWS.config.http_debug)
+    assert_equal(true, LWS.config.http_debug_headers)
+    assert_equal(true, LWS.config.json_debug)
   end
 
 end

data/test/ticket_test.rb

@@ -78,7 +78,7 @@ class TestTicketMessage < MiniTest::Test
     #assert_instance_of(Attachment, @message.attachments.first)
     assert_instance_of(LWS::Auth::Company, @message.company)
     assert_instance_of(Ticket, @message.ticket)
-    assert_equal(@message.ticket, @ticket)
+    assert_equal(@ticket, @message.ticket)
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lws
 version: !ruby/object:Gem::Version
-  version: 6.1.1
+  version: 6.1.2
 platform: ruby
 authors:
 - LeftClick B.V.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-28 00:00:00.000000000 Z
+date: 2018-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
@@ -230,6 +230,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".yardopts"
 - CHANGELOG.md
 - Gemfile
 - README.md