lws 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f26b35e7bb64ddc71e49948f3d6284e30eeb392
-  data.tar.gz: 2490983861647ac29dd8bdde374433922ad42ada
+  metadata.gz: a8a4f59dac348f40f4c5530b07d71147a9c4078e
+  data.tar.gz: 94615b304d6d65389c35b1ee741cfb5e7d6cdfc3
 SHA512:
-  metadata.gz: df6c725b492324812109da79e5222b2d2f71ee0fc23e8ac22f5f5af91025bef9dd7db5e645cc76c74b83def49a283512072cb8a6ec74c9c830e52d3b63989765
-  data.tar.gz: 85d876a354663c9af7e40fa03b0a05b5edd4abf0bfb080425598fdf7e5be78c9a3557c795610cb9baa5e9fb30f816f34c952a3249ea4defbdfe77a0e96bf5fa9
+  metadata.gz: afbc173c984051c4577386663d57e31166fcbca9428ef17f8a5a4f293be346061ee9adc35d0a865aff52a005513cca2cf2946174a229d6965999a7ea4836d23f
+  data.tar.gz: 9ca37c4dc44a665191bf06163f52f340de2e49c1d0cec30b16b3914f9df1f8ffc28f17699db5c82ee279a81aaed11128a040b25fb75bb1e7b14d5cd803457d8f

data/Rakefile

@@ -27,6 +27,8 @@ YARD::Rake::YardocTask.new do |t|
                "--title", "LeftClick Web Services Documentation"]
 end
 
+task doc: :yard
+
 desc "Insert/update copyright headers in all script files"
 task :copyright do
   copyright_text = File.read("copyright.txt")

data/lib/lws/auth.rb

@@ -1,4 +1,3 @@
-# = The auth app module
 #
 # Copyright © 2016 LeftClick B.V.
 #
@@ -9,15 +8,19 @@
 # contact LeftClick B.V. at:  Geldropseweg 8B, 5731 SG Mierlo, The
 # Netherlands, info@leftclick.eu, +31492-782120.
 
+
+# = The auth app module
 module LWS::Auth
 
+  # :nocov:
   unless defined? ENDPOINT
     # The API endpoint for the auth app
     ENDPOINT = { production: "https://leftclick.cloud/" ,
                  development: "https://dev.leftclick.cloud/" }
   end
+  # :nocov:
 
-  # @!visibility private
+  #@!visibility private
   def self.api
     LWS.setup_api(LWS.config.endpoints[:auth] ||
                   ENDPOINT[LWS.config.environment])
@@ -77,10 +80,6 @@ module LWS::Auth
 
     #@!attribute updated_at
     #  @return [String] the timestamp of when the account was last updated
-
-    def initialize(attrs = {})
-      super
-    end
   end
 
   # = The app class
@@ -111,9 +110,7 @@ module LWS::Auth
     #@!attribute updated_at
     #  @return [String] the timestamp of when the app was last updated
 
-    def initialize(attrs = {})
-      super
-    end
+    self # To ensure that YARD does not skip the attributes of this class
   end
 
   # = The company class
@@ -168,10 +165,6 @@ module LWS::Auth
 
     #@!attribute updated_at
     #  @return [String] the timestamp of when the company was last updated
-
-    def initialize(attrs = {})
-      super
-    end
   end
 
   # = The device class
@@ -199,10 +192,6 @@ module LWS::Auth
 
     #@!attribute updated_at
     #  @return [String] the timestamp of when the device was last updated
-
-    def initialize(attrs = {})
-      super
-    end
   end
 
   # = The token class
@@ -259,10 +248,6 @@ module LWS::Auth
 
     #@!attribute updated_at
     #  @return [String] the timestamp of when the token was last updated
-
-    def initialize(attrs = {})
-      super
-    end
   end
 
   # = The user class
@@ -293,10 +278,6 @@ module LWS::Auth
 
     #@!attribute updated_at
     #  @return [String] the timestamp of when the user was last updated
-
-    def initialize(attrs = {})
-      super
-    end
   end
 
 end

data/lib/lws/corporate_website.rb

@@ -1,4 +1,3 @@
-# = The corporate website app module
 #
 # Copyright © 2016 LeftClick B.V.
 #
@@ -9,13 +8,17 @@
 # contact LeftClick B.V. at:  Geldropseweg 8B, 5731 SG Mierlo, The
 # Netherlands, info@leftclick.eu, +31492-782120.
 
+
+# = The corporate website app module
 module LWS::CorporateWebsite
 
+  # :nocov:
   unless defined? ENDPOINT
     # The API endpoint for the corporate website app
     ENDPOINT = { production: "https://www.leftclick.cloud/",
                  development: "https://www-dev.leftclick.cloud/" }
   end
+  # :nocov:
 
   #@!visibility private
   def self.api
@@ -101,9 +104,7 @@ module LWS::CorporateWebsite
     #@!attribute updated_at
     #  @return [String] the timestamp of when the article was last updated
 
-    def initialize(attrs = {})
-      super
-    end
+    self # To ensure that YARD does not skip the attributes of this class
   end
 
   # = The opening hours class
@@ -138,9 +139,7 @@ module LWS::CorporateWebsite
     #@!attribute updated_at
     #  @return [String] the timestamp of when the office time was last updated
 
-    def initialize(attrs={})
-      super
-    end
+    self # To ensure that YARD does not skip the attributes of this class
   end
 
 end

data/lib/lws/generic.rb

@@ -1,6 +1,3 @@
-# = The generic app module
-#
-# This module contains classes that are present in all applications.
 #
 # Copyright © 2016 LeftClick B.V.
 #
@@ -11,6 +8,10 @@
 # contact LeftClick B.V. at:  Geldropseweg 8B, 5731 SG Mierlo, The
 # Netherlands, info@leftclick.eu, +31492-782120.
 
+
+# = The generic app module
+#
+# This module contains classes that are present in all applications.
 module LWS::Generic
 
   # = The generic model class
@@ -37,9 +38,7 @@ module LWS::Generic
     #@!attribute updated_at
     #  @return [String] the timestamp of when the configuration was last updated
 
-    def initialize(attrs = {})
-     super
-    end
+    self # To ensure that YARD does not skip the attributes of this class
   end
 
   # = The task class
@@ -74,9 +73,7 @@ module LWS::Generic
     #@!attribute updated_at
     #  @return [String] the timestamp of when the map was last updated
 
-    def initialize(attrs = {})
-     super
-    end
+    self # To ensure that YARD does not skip the attributes of this class
   end
 
 end

data/lib/lws/maps.rb

@@ -1,4 +1,3 @@
-# = The maps app module
 #
 # Copyright © 2016 LeftClick B.V.
 #
@@ -9,13 +8,17 @@
 # contact LeftClick B.V. at:  Geldropseweg 8B, 5731 SG Mierlo, The
 # Netherlands, info@leftclick.eu, +31492-782120.
 
+
+# = The maps app module
 module LWS::Maps
 
+  # :nocov:
   unless defined? ENDPOINT
     # The API endpoint for the map app
     ENDPOINT = { production: "https://maps.leftclick.cloud/",
                  development: "https://maps-dev.leftclick.cloud/" }
   end
+  # :nocov:
 
   #@!visibility private
   def self.api
@@ -63,10 +66,6 @@ module LWS::Maps
 
     #@!attribute updated_at
     #  @return [String] the timestamp of when the map was last updated
-
-    def initialize(attrs = {})
-      super
-    end
   end
 
   # = The map marker class
@@ -100,10 +99,6 @@ module LWS::Maps
 
     #@!attribute updated_at
     #  @return [String] the timestamp of when the map marker was last updated
-
-    def initialize(attrs={})
-      super
-    end
   end
 
 end

data/lib/lws/presence.rb

@@ -1,4 +1,3 @@
-# = The presence app module
 #
 # Copyright © 2016 LeftClick B.V.
 #
@@ -9,13 +8,17 @@
 # contact LeftClick B.V. at:  Geldropseweg 8B, 5731 SG Mierlo, The
 # Netherlands, info@leftclick.eu, +31492-782120.
 
+
+# = The presence app module
 module LWS::Presence
 
+  # :nocov:
   unless defined? ENDPOINT
     # The API endpoint for the presence app
     ENDPOINT = { production: "https://presence.leftclick.cloud/",
                  development: "https://presence-dev.leftclick.cloud/" }
   end
+  # :nocov:
 
   #@!visibility private
   def self.api
@@ -76,10 +79,6 @@ module LWS::Presence
 
     #@!attribute updated_at
     #  @return [String] the timestamp of when the location was last updated
-
-    def initialize(attrs = {})
-      super
-    end
   end
   
   # = The person class
@@ -145,7 +144,6 @@ module LWS::Presence
 
     #@!attribute updated_at
     #  @return [String] the timestamp of when the person was last updated
-   
   end
 
 end

data/lib/lws/stubbing.rb

@@ -1,3 +1,14 @@
+#
+# Copyright © 2016 LeftClick B.V.
+#
+# This software is property of LeftClick B.V. and cannot be redistributed
+# and/or modified without permission.  The software or any of its parts
+# cannot be used for any other purposes than the LeftClick services and
+# only during a valid license subscription.  For more information, please
+# contact LeftClick B.V. at:  Geldropseweg 8B, 5731 SG Mierlo, The
+# Netherlands, info@leftclick.eu, +31492-782120.
+
+
 module LWS
 
   # = Class that regulates request stubbing based on a tree of fixtures

data/lib/lws/ticket.rb

@@ -1,4 +1,3 @@
-# = The ticket app module
 #
 # Copyright © 2016 LeftClick B.V.
 #
@@ -9,13 +8,17 @@
 # contact LeftClick B.V. at:  Geldropseweg 8B, 5731 SG Mierlo, The
 # Netherlands, info@leftclick.eu, +31492-782120.
 
+
+# = The ticket app module
 module LWS::Ticket
 
+  # :nocov:
   unless defined? ENDPOINT
     # The API endpoint for the ticket app
     ENDPOINT = { production: "https://ticket.leftclick.cloud/",
                  development: "https://ticket-dev.leftclick.cloud/" }
   end
+  # :nocov:
 
   #@!visibility private
   def self.api
@@ -127,10 +130,6 @@ module LWS::Ticket
 
     #@!attribute updated_at
     #  @return [String] the timestamp of when the ticket was last updated
-
-    def initialize(attrs={})
-      super
-    end
   end
 
   # = The ticket message class
@@ -182,10 +181,6 @@ module LWS::Ticket
     #@!attribute updated_at
     #  @return [String] the timestamp of when the ticket message was last
     #    updated
-
-    def initialize(attrs={})
-      super
-    end
   end
 
   # = The ticket message attachment class
@@ -223,10 +218,6 @@ module LWS::Ticket
     #@!attribute updated_at
     #  @return [String] the timestamp of when the ticket message attachment
     #    was last updated
-
-    def initialize(attrs={})
-      super
-    end
   end
 
   # = The ticket group class
@@ -248,9 +239,7 @@ module LWS::Ticket
     #@!attribute updated_at
     #  @return [String] the timestamp of when the ticket group was last updated
 
-    def initialize(attrs={})
-      super
-    end
+    self # To ensure that YARD does not skip the attributes of this class
   end
 
   # = The ticket tag class
@@ -282,10 +271,6 @@ module LWS::Ticket
 
     #@!attribute updated_at
     #  @return [String] the timestamp of when the ticket tag was last updated
-
-    def initialize(attrs={})
-      super
-    end
   end
 
 end

data/lib/lws/version.rb

@@ -8,10 +8,11 @@
 # contact LeftClick B.V. at:  Geldropseweg 8B, 5731 SG Mierlo, The
 # Netherlands, info@leftclick.eu, +31492-782120.
 
+
 module LWS
 
   # The LWS library version.
   # @note This is not the API version!
-  VERSION = '0.4.1'
+  VERSION = '0.4.2'
 
 end

data/lib/lws.rb

@@ -8,6 +8,7 @@
 # contact LeftClick B.V. at:  Geldropseweg 8B, 5731 SG Mierlo, The
 # Netherlands, info@leftclick.eu, +31492-782120.
 
+
 require "faraday_middleware"
 require "hashie"
 require "her"
@@ -20,7 +21,7 @@ require "lws/version"
 
 WebMock.disable!
 
-# = Main LeftClick web services module
+# = The main LeftClick web services module
 #
 # This module is the main namespace for the web service/application
 # libraries that are represented by submodules.  The {LWS} module is used
@@ -33,6 +34,7 @@ module LWS
   SUPPORTED_APPS = [:generic, :auth, :corporate_website, :maps, :presence,
                     :ticket]
 
+  # @private
   # @!visibility private
   class HTTPLogger < Faraday::Response::Middleware
 
@@ -62,6 +64,7 @@ module LWS
 
   end
 
+  # @private
   # @!visibility private
   class JSONLogger < Faraday::Response::Middleware
 
@@ -78,6 +81,7 @@ module LWS
 
   end
 
+  # @private
   # @!visibility private
   class RequestHeaders < Faraday::Middleware
 
@@ -180,6 +184,7 @@ module LWS
     return self
   end
 
+  # @private
   # @!visibility private
   def self.setup_api(api_url)
     api = Her::API.new
@@ -218,7 +223,7 @@ module LWS
     end
   end
 
-  # (Re)load the stubbing if enabled (usually done by {.setup}).
+  # (Re)loads the stubbing if enabled (usually done by {.setup}).
   #
   # @return [Stubbing, nil] the stubbing object or +nil+ if disabled
   def self.load_stubbing

data/test/api_token_middleware_test.rb

@@ -8,6 +8,7 @@
 # contact LeftClick B.V. at:  Geldropseweg 8B, 5731 SG Mierlo, The
 # Netherlands, info@leftclick.eu, +31492-782120.
 
+
 require "test_helper"
 
 class WorkingTokenAuthenticator < Faraday::Middleware

data/test/auth_test.rb

@@ -8,6 +8,7 @@
 # contact LeftClick B.V. at:  Geldropseweg 8B, 5731 SG Mierlo, The
 # Netherlands, info@leftclick.eu, +31492-782120.
 
+
 require "test_helper"
 
 class TestAuthAccount < MiniTest::Test

data/test/caching_test.rb

@@ -8,6 +8,7 @@
 # contact LeftClick B.V. at:  Geldropseweg 8B, 5731 SG Mierlo, The
 # Netherlands, info@leftclick.eu, +31492-782120.
 
+
 require "test_helper"
 
 class TestCaching < MiniTest::Test

data/test/{test_corporate_website.rb → corporate_website_test.rb}

@@ -8,6 +8,7 @@
 # contact LeftClick B.V. at:  Geldropseweg 8B, 5731 SG Mierlo, The
 # Netherlands, info@leftclick.eu, +31492-782120.
 
+
 require "test_helper"
 
 class TestCorporateWebsiteArticle < MiniTest::Test

data/test/generic_test.rb

@@ -8,6 +8,7 @@
 # contact LeftClick B.V. at:  Geldropseweg 8B, 5731 SG Mierlo, The
 # Netherlands, info@leftclick.eu, +31492-782120.
 
+
 require "test_helper"
 
 class TestGenericConfiguration < MiniTest::Test

data/test/logger_test.rb

@@ -8,6 +8,7 @@
 # contact LeftClick B.V. at:  Geldropseweg 8B, 5731 SG Mierlo, The
 # Netherlands, info@leftclick.eu, +31492-782120.
 
+
 require "test_helper"
 
 class TestLogger < MiniTest::Test

data/test/maps_test.rb

@@ -8,6 +8,7 @@
 # contact LeftClick B.V. at:  Geldropseweg 8B, 5731 SG Mierlo, The
 # Netherlands, info@leftclick.eu, +31492-782120.
 
+
 require "test_helper"
 
 class TestMapsMap < MiniTest::Test

data/test/presence_test.rb

@@ -8,6 +8,7 @@
 # contact LeftClick B.V. at:  Geldropseweg 8B, 5731 SG Mierlo, The
 # Netherlands, info@leftclick.eu, +31492-782120.
 
+
 require "test_helper"
 
 class TestPresencePerson < MiniTest::Test

data/test/setup_test.rb

@@ -0,0 +1,42 @@
+#
+# Copyright © 2016 LeftClick B.V.
+#
+# This software is property of LeftClick B.V. and cannot be redistributed
+# and/or modified without permission.  The software or any of its parts
+# cannot be used for any other purposes than the LeftClick services and
+# only during a valid license subscription.  For more information, please
+# contact LeftClick B.V. at:  Geldropseweg 8B, 5731 SG Mierlo, The
+# Netherlands, info@leftclick.eu, +31492-782120.
+
+
+require "test_helper"
+
+class TestSetup < MiniTest::Test
+
+  def test_cannot_leave_out_api_token
+    assert_raises do
+      LWS.setup { }
+    end
+
+    # Restore the configuration
+    reconfigure
+  end
+
+  def test_get_environment_from_environment
+    with_env("LC_LWS_ENV" => "production") do
+      reconfigure
+    end
+    assert_equal(LWS.config.environment, :production)
+
+    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)
+
+    # Restore the configuration
+    reconfigure
+  end
+
+end

data/test/stubbing_test.rb

@@ -8,6 +8,7 @@
 # contact LeftClick B.V. at:  Geldropseweg 8B, 5731 SG Mierlo, The
 # Netherlands, info@leftclick.eu, +31492-782120.
 
+
 require "test_helper"
 
 class TestStubbing < MiniTest::Test

data/test/support/with_env.rb

@@ -0,0 +1,24 @@
+#
+# Copyright © 2016 LeftClick B.V.
+#
+# This software is property of LeftClick B.V. and cannot be redistributed
+# and/or modified without permission.  The software or any of its parts
+# cannot be used for any other purposes than the LeftClick services and
+# only during a valid license subscription.  For more information, please
+# contact LeftClick B.V. at:  Geldropseweg 8B, 5731 SG Mierlo, The
+# Netherlands, info@leftclick.eu, +31492-782120.
+
+
+class Minitest::Test
+
+  def with_env(settings)
+    old_env = {}
+    settings.each { |k, v| old_env[k], ENV[k] = ENV[k], v }
+    begin
+      yield
+    ensure
+      settings.each { |k, v| ENV[k] = old_env[k] }
+    end
+  end
+
+end

data/test/test_helper.rb

@@ -8,6 +8,7 @@
 # contact LeftClick B.V. at:  Geldropseweg 8B, 5731 SG Mierlo, The
 # Netherlands, info@leftclick.eu, +31492-782120.
 
+
 require 'simplecov'
 require 'simplecov-rcov'
 SimpleCov.formatters = [
@@ -22,7 +23,7 @@ SimpleCov.at_exit do
   result.format!
   simplecov_test_suites = ['minitest']
   parallel_offset = ENV['PARALLEL_TEST_GROUPS'] ? ENV['PARALLEL_TEST_GROUPS'].to_i - 1 : 0
-  minimum_coverage = 90
+  minimum_coverage = 97
   # Count the number of commas in the command name to figure out how many result groups were combined into this result
   if result.command_name.scan(/,/).size + 1 >= simplecov_test_suites.size + (parallel_offset * 2) # two parallel suites
     # We only want to enforce minimum coverage after all test suites finish
@@ -37,6 +38,9 @@ require "logger"
 require "lws"
 require "minitest/autorun"
 
+# Load the support libraries
+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 = {})

data/test/{test_ticket.rb → ticket_test.rb}

@@ -8,6 +8,7 @@
 # contact LeftClick B.V. at:  Geldropseweg 8B, 5731 SG Mierlo, The
 # Netherlands, info@leftclick.eu, +31492-782120.
 
+
 require "test_helper"
 
 class TestTicketTicket < MiniTest::Test
@@ -43,7 +44,7 @@ class TestTicketMessage < MiniTest::Test
 
   def setup
     @ticket = Ticket.all.first
-    # Messages only exist as child object op tickets
+    # Messages only exist as child object of tickets
     @message = @ticket.messages.first
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lws
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - LeftClick B.V.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-09 00:00:00.000000000 Z
+date: 2017-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
@@ -234,16 +234,18 @@ files:
 - test/api_token_middleware_test.rb
 - test/auth_test.rb
 - test/caching_test.rb
+- test/corporate_website_test.rb
 - test/fixtures/auth.yml
 - test/fixtures/permissions.yml
 - test/generic_test.rb
 - test/logger_test.rb
 - test/maps_test.rb
 - test/presence_test.rb
+- test/setup_test.rb
 - test/stubbing_test.rb
-- test/test_corporate_website.rb
+- test/support/with_env.rb
 - test/test_helper.rb
-- test/test_ticket.rb
+- test/ticket_test.rb
 homepage: https://leftclick.eu/
 licenses: []
 metadata: {}
@@ -271,13 +273,15 @@ test_files:
 - test/api_token_middleware_test.rb
 - test/auth_test.rb
 - test/caching_test.rb
+- test/corporate_website_test.rb
 - test/fixtures/auth.yml
 - test/fixtures/permissions.yml
 - test/generic_test.rb
 - test/logger_test.rb
 - test/maps_test.rb
 - test/presence_test.rb
+- test/setup_test.rb
 - test/stubbing_test.rb
-- test/test_corporate_website.rb
+- test/support/with_env.rb
 - test/test_helper.rb
-- test/test_ticket.rb
+- test/ticket_test.rb