lws 0.1.1 → 0.1.2

data/lib/lws/auth.rb

@@ -6,7 +6,7 @@ module LWS::Auth
 
   # @!visibility private
   def self.api
-    @@api ||= LWS.setup_api(LWS.config.endpoints[:auth] || ENDPOINT)
+    LWS.setup_api(LWS.config.endpoints[:auth] || ENDPOINT)
   end
 
   ### Generic classes

data/lib/lws/maps.rb

@@ -6,7 +6,7 @@ module LWS::Maps
 
   #@!visibility private
   def self.api
-    @@api ||= LWS.setup_api(LWS.config.endpoints[:maps] || ENDPOINT)
+    LWS.setup_api(LWS.config.endpoints[:maps] || ENDPOINT)
   end
 
   ### Generic classes

data/lib/lws/presence.rb

@@ -6,7 +6,7 @@ module LWS::Presence
 
   #@!visibility private
   def self.api
-    @@api ||= LWS.setup_api(LWS.config.endpoints[:presence] || ENDPOINT)
+    LWS.setup_api(LWS.config.endpoints[:presence] || ENDPOINT)
   end
 
   ### Generic classes

data/lib/lws/version.rb

@@ -0,0 +1,7 @@
+module LWS
+
+  # The LWS library version.
+  # @note This is not the API version!
+  VERSION = '0.1.2'
+
+end

data/lib/lws.rb

@@ -1,7 +1,10 @@
+require "faraday_middleware"
 require "hashie"
 require "her"
 require "pp"
 
+require "lws/version"
+
 # = Main LeftClick web services module
 #
 # This module is the main namespace for the web service/application
@@ -14,10 +17,6 @@ module LWS
   # {.setup}.
   SUPPORTED_APPS = [:generic, :auth, :maps, :presence]
 
-  # The LWS library version.
-  # @note This is not the API version!
-  VERSION = '0.1.1'
-
   # @!visibility private
   class HTTPLogger < Faraday::Response::Middleware
 
@@ -76,6 +75,10 @@ module LWS
     #  @return [String] the API token necessary to gain access
     property :api_token
 
+    #@!attribute caching_object
+    #  @return [#read, #write] an object that can cache request results
+    property :caching_object, default: nil
+
     #@!attribute endpoints
     #  @return [Hash{Symbol=>String}] a mapping of application endpoint
     #    overrides
@@ -120,6 +123,9 @@ module LWS
     api = Her::API.new
     api.setup(url: api_url) do |c|
       # Request
+      if config.caching_object
+        c.use FaradayMiddleware::Caching, config.caching_object
+      end
       c.use RequestHeaders, config.api_token
       c.use Faraday::Request::UrlEncoded
 

data/lws.gemspec

@@ -1,6 +1,5 @@
 # encoding: utf-8
-$:.push File.expand_path("lib", __FILE__)
-require "lws"
+require File.expand_path("../lib/lws/version", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "lws"

data/test/test_caching.rb

@@ -0,0 +1,50 @@
+require "test_helper"
+
+class TestCaching < MiniTest::Unit::TestCase
+
+  # Class used to check if data is read/written to the cache
+  class CacheTest
+
+    attr_reader :last_read_key
+    attr_reader :last_written_key, :last_written_value
+
+    def read(key)
+      @last_read_key = key
+      nil
+    end
+
+    def write(key, value)
+      @last_written_key, @last_written_value = key, value
+      nil
+    end
+
+  end
+
+  def setup
+    @cache_mock = CacheTest.new
+
+    # Redo the LWS setup with cache
+    LWS.setup do |config|
+      config.api_token = ENV["LC_LWS_TEST_TOKEN"]
+      config.caching_object = @cache_mock
+      if ENV["LC_LWS_TEST_DEBUG"].present?
+        config.http_debug = true
+        config.json_debug = true
+      end
+      config.endpoints = { auth: "https://auth-dev.leftclick.eu",
+                           maps: "https://maps-dev.leftclick.eu",
+                           presence: "https://presence-dev.leftclick.eu" }
+    end
+  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")
+    refute_nil(@cache_mock.last_written_value)
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lws
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-15 00:00:00.000000000 Z
+date: 2016-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &15275000 !ruby/object:Gem::Requirement
+  requirement: &14782680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *15275000
+  version_requirements: *14782680
 - !ruby/object:Gem::Dependency
   name: her
-  requirement: &15274240 !ruby/object:Gem::Requirement
+  requirement: &14782120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.8.1
   type: :runtime
   prerelease: false
-  version_requirements: *15274240
+  version_requirements: *14782120
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &15273720 !ruby/object:Gem::Requirement
+  requirement: &14781540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *15273720
+  version_requirements: *14781540
 - !ruby/object:Gem::Dependency
   name: her
-  requirement: &15273060 !ruby/object:Gem::Requirement
+  requirement: &14780780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 0.8.1
   type: :development
   prerelease: false
-  version_requirements: *15273060
+  version_requirements: *14780780
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &15272520 !ruby/object:Gem::Requirement
+  requirement: &14780180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *15272520
+  version_requirements: *14780180
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &15271840 !ruby/object:Gem::Requirement
+  requirement: &14779500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,7 +76,7 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *15271840
+  version_requirements: *14779500
 description: ! "This library for Ruby provides access to the LeftClick\n web services/applications
   using a model-based structure that abstracts from API calls\n using the available
   REST interfaces."
@@ -96,8 +96,10 @@ files:
 - lib/lws/generic.rb
 - lib/lws/maps.rb
 - lib/lws/presence.rb
+- lib/lws/version.rb
 - lws.gemspec
 - test/test_auth.rb
+- test/test_caching.rb
 - test/test_generic.rb
 - test/test_helper.rb
 - test/test_maps.rb
@@ -128,6 +130,7 @@ specification_version: 3
 summary: LeftClick web services library for Ruby
 test_files:
 - test/test_auth.rb
+- test/test_caching.rb
 - test/test_generic.rb
 - test/test_helper.rb
 - test/test_maps.rb