lws 7.2.0 → 7.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db2a5afb03078543a2c129a2eb447c9038032daba9b06ee4c7ce16e484fa356b
-  data.tar.gz: 9bd4e6f9a94ac7e86ed1572617c99fd8330ce718516a847b9ef7aecc5d96380f
+  metadata.gz: 6deffc4e78a47854d29873d8fc9a28362613690de1c942ae8eed2c5e83e937ca
+  data.tar.gz: a1986c2225a9f172a12cacc6a37d00a19458cbe396212a3281cb74c7901db850
 SHA512:
-  metadata.gz: 34d875da7b9139b7115a15cc6b61ef7930956dae43858ff386da3738e8eedef3f9250f99fd0c62fb68a76725e9811fc9ab0ebd7c1c60847cf2d7a9479c1ef187
-  data.tar.gz: 4f792cfef73be50479bd9dbf91814e66e46a2bc1612203eb40d91fded571fa1b5a57820c585560524a578a658faec0d151b462dfba33e297536d9484218ecc82
+  metadata.gz: 3e8856e550c55c227c1671a42573f60044a7bee2e16be6a4f35f5e954cd2b37289a8ee4eee225894d5073e82cb37ee0111bd29c464ccad8c36b3872a0698eacf
+  data.tar.gz: c3e1c5f33253614acf54842796ccb4c9b3b532b4f172d22c7f5f0456056425c15f785a8df29db2af5eb80828bcd76ae3bf7131d74cff967702ad350b40f78656

data/lib/lws.rb

@@ -10,6 +10,7 @@
 
 
 require "faraday_middleware"
+require "faraday/http_cache"
 require "hashie"
 require "multi_json"
 require "spyke"
@@ -116,6 +117,12 @@ module LWS
       if config.caching_object
         c.use FaradayMiddleware::Caching, config.caching_object
       end
+      if config.http_caching
+        logger = config.http_debug ? config.logger : nil
+        c.use Faraday::HttpCache, store: config.http_caching_object,
+                                  logger: logger,
+                                  shared_cache: false
+      end
       c.use RequestHeaders, config.api_token
       c.use config.api_token_middleware if config.api_token_middleware.present?
       c.request :json

data/lib/lws/apps/generic.rb

@@ -157,7 +157,11 @@ module LWS::Generic
     # @return [Object, nil] the digged up value or +nil+
     def dig(*attrs)
       attr = attrs.shift
-      value = send(attr)
+      value = begin
+                send(attr)
+              rescue NoMethodError
+                nil
+              end
       return nil if value.nil?
       return value if attrs.empty?
       raise TypeError, "#{value.class} does not have #dig method" unless value.respond_to? :dig

data/lib/lws/config.rb

@@ -45,6 +45,15 @@ module LWS
     #     (default: +:production+)
     property :environment, default: :production
 
+    #@!attribute http_caching
+    #  @return [Boolean] whether HTTP caching is enabled
+    property :http_caching, default: true
+
+    #@!attribute http_caching_object
+    #  @return [#read, #write, #delete] an object that caches results
+    #    respecting HTTP expiration (instead of an in-memory hash)
+    property :http_caching_object, default: nil
+
     #@!attribute http_debug
     #  @return [Boolean] whether to show HTTP debug messages (default: +false+)
     property :http_debug, default: false

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.0".freeze
+  VERSION = "7.2.1".freeze
 
 end

data/test/http_caching_test.rb

@@ -0,0 +1,80 @@
+#
+# Copyright © 2016–2020 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:  Schootense Dreef 20A, 5708 HZ Helmond, The
+# Netherlands, info@leftclick.eu, +3185-4444-004.
+
+
+require "test_helper"
+
+class TestHTTPCaching < MiniTest::Test
+
+  # Class used to check if data is read/written to or remove from the cache
+  class HTTPCacheTest
+
+    attr_reader :last_read_key
+    attr_reader :last_written_key, :last_written_value
+    attr_reader :last_deleted_key
+
+    def read(key)
+      @last_read_key = key
+      nil
+    end
+
+    def write(key, value)
+      @last_written_key = key
+      @last_written_value = value
+      nil
+    end
+
+    def delete(key)
+      @last_deleted_key = key
+      nil
+    end
+
+  end
+
+  def setup
+    @cache_mock = HTTPCacheTest.new
+
+    # Redo the LWS setup with an HTTP caching object
+    LWS.setup do |config|
+      config.api_token = ENV["LC_LWS_TEST_TOKEN"]
+      config.http_caching_object = @cache_mock
+      if ENV["LC_LWS_TEST_DEBUG"].present?
+        config.http_debug = true
+        config.http_debug_headers = true
+      end
+      config.environment = :development
+    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)
+    assert_nil(@cache_mock.last_deleted_key)
+
+    new_configuration = LWS::Auth::Configuration.create(key: "test", value: "some_value")
+    refute_nil(@cache_mock.last_deleted_key)
+
+    _configurations = LWS::Auth::Configuration.where(key: "test").to_a
+    refute_nil(@cache_mock.last_read_key)
+    assert_equal(@cache_mock.last_read_key, @cache_mock.last_written_key)
+    refute_nil(@cache_mock.last_written_value)
+
+    old_key = @cache_mock.last_deleted_key.dup
+    new_configuration.destroy
+    refute_equal(old_key, @cache_mock.last_deleted_key)
+  end
+
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: lws
 version: !ruby/object:Gem::Version
-  version: 7.2.0
+  version: 7.2.1
 platform: ruby
 authors:
 - LeftClick B.V.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-23 00:00:00.000000000 Z
+date: 2020-10-29 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday-http-cache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
@@ -262,6 +276,7 @@ files:
 - test/fixtures/auth.yml
 - test/fixtures/permissions.yml
 - test/generic_test.rb
+- test/http_caching_test.rb
 - test/json_parser_test.rb
 - test/logger_test.rb
 - test/maps_test.rb
@@ -295,6 +310,7 @@ signing_key:
 specification_version: 4
 summary: LeftClick web services library for Ruby
 test_files:
+- test/http_caching_test.rb
 - test/generic_test.rb
 - test/caching_test.rb
 - test/api_token_middleware_test.rb