lws 0.1.4 → 0.1.5

data/README.rdoc

@@ -36,13 +36,13 @@ ORM's:
 
   loc = Presence::Location.where(name: "Test")
   loc.destroy
-   
+
 == Configuration
 
 The following example uses a much more elaborate setup:
 
   LWS.setup do |config|
-    config.api_token = proc { "token" + Time.now.to_s }
+    config.api_token_middleware = TokenAuthenticator
     config.caching_object = MyRedisCache.new
     config.environment = :development
     config.endponts = { maps: "https://maps.leftclick.eu" }
@@ -54,7 +54,18 @@ In this setup, a caching object is used that follows the
 +FaradayMiddleWare::Caching+ API.  It uses all development API endpoints,
 except for maps, which is overriden to use the production endpoint.  Also
 HTTP request and JSON data debug logging is enabled.
-Also tokens are dynamically determined at runtime by the given proc block.
+Also a custom API token authenticator class is used that should implement
+the +Faraday::Middleware+ interface and set the +X-Token+ header with the
+runtime determined API token as value, for example:
+
+  class TokenAuthenticator < Faraday::Middleware
+
+    def call(env)
+      env[:request_headers]["X-Token"] = … # Some calculated token
+      @app.call(env)
+    end
+
+  end
 
 The +LC_LWS_ENV+  is supported to override the LWS environment.
 Allowed values are "production" (default) and "development".

data/lib/lws/auth.rb

@@ -1,8 +1,8 @@
 # = The auth app module
 module LWS::Auth
 
-  # The API endpoint for the auth app
   unless defined? ENDPOINT
+    # The API endpoint for the auth app
     ENDPOINT = { production: "https://auth.leftclick.eu/" ,
                  development: "https://auth-dev.leftclick.eu/" }
   end
@@ -15,10 +15,12 @@ module LWS::Auth
 
   ### Generic classes
 
+  # (see Generic::Configuration)
   class Configuration < LWS::Generic::Configuration
     use_api LWS::Auth.api
   end
 
+  # (see Generic::Task)
   class Task < LWS::Generic::Task
     use_api LWS::Auth.api
   end

data/lib/lws/maps.rb

@@ -1,8 +1,8 @@
 # = The maps app module
 module LWS::Maps
 
-  # The API endpoint for the map app
   unless defined? ENDPOINT
+    # The API endpoint for the map app
     ENDPOINT = { production: "https://maps.leftclick.eu/",
                  development: "https://maps-dev.leftclick.eu/" }
   end
@@ -15,10 +15,12 @@ module LWS::Maps
 
   ### Generic classes
 
+  # (see Generic::Configuration)
   class Configuration < LWS::Generic::Configuration
     use_api LWS::Maps.api
   end
 
+  # (see Generic::Task)
   class Task < LWS::Generic::Task
     use_api LWS::Maps.api
   end

data/lib/lws/presence.rb

@@ -1,8 +1,8 @@
 # = The presence app module
 module LWS::Presence
 
-  # The API endpoint for the presence app
   unless defined? ENDPOINT
+    # The API endpoint for the presence app
     ENDPOINT = { production: "https://presence.leftclick.eu/",
                  development: "https://presence-dev.leftclick.eu/" }
   end
@@ -15,10 +15,12 @@ module LWS::Presence
 
   ### Generic classes
 
+  # (see Generic::Configuration)
   class Configuration < LWS::Generic::Configuration
     use_api LWS::Presence.api
   end
 
+  # (see Generic::Task)
   class Task < LWS::Generic::Task
     use_api LWS::Presence.api
   end
@@ -70,6 +72,7 @@ module LWS::Presence
     end
   end
   
+  # = The person class
   class Person < LWS::Generic::Model
     use_api LWS::Presence.api
 

data/lib/lws/version.rb

@@ -2,6 +2,6 @@ module LWS
 
   # The LWS library version.
   # @note This is not the API version!
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 
 end

data/lib/lws.rb

@@ -59,11 +59,7 @@ module LWS
     end
 
     def call(env)
-      env[:request_headers]["X-Token"] = if @token.is_a? Proc
-                                           @token.call
-                                         else
-                                           @token
-                                         end.to_s
+      env[:request_headers]["X-Token"] = @token if @token
       env[:request_headers]["Accept"] = "application/json"
       @app.call(env)
     end
@@ -76,10 +72,14 @@ module LWS
   # = The API configuration class
   class Config < Hashie::Dash
     #@!attribute api_token
-    #  @return [String, Proc] the API token necessary to gain access or
-    #     a proc block that returns it
+    #  @return [String, nil] the API token necessary to gain access
     property :api_token
 
+    #@!attribute api_token_middleware
+    # @return [Fardaday::Middleware, nil] the API token middleware that
+    #   provides the API token to the request at runtime
+    property :api_token_middleware
+
     #@!attribute caching_object
     #  @return [#read, #write] an object that can cache request results
     property :caching_object, default: nil
@@ -120,7 +120,9 @@ module LWS
     @@config = Config.new
     yield @@config
 
-    raise "API token is required" if config.api_token.blank?
+    if config.api_token.blank? and config.api_token_middleware.blank?
+      raise "API token or API token middleware is required"
+    end
 
     # Override the environment if needed
     if ENV["LC_LWS_ENV"].present?
@@ -141,6 +143,7 @@ module LWS
         c.use FaradayMiddleware::Caching, config.caching_object
       end
       c.use RequestHeaders, config.api_token
+      c.use config.api_token_middleware if config.api_token_middleware.present?
       c.use Faraday::Request::UrlEncoded
 
       # Response

data/test/test_api_token_middleware.rb

@@ -0,0 +1,61 @@
+require "test_helper"
+
+class WorkingTokenAuthenticator < Faraday::Middleware
+
+  def call(env)
+    env[:request_headers]["X-Token"] = ENV["LC_LWS_TEST_TOKEN"]
+    @app.call(env)
+  end
+
+end
+
+class BrokenTokenAuthenticator < Faraday::Middleware
+
+  def call(env)
+    env[:request_headers]["X-Token"] = ""
+    @app.call(env)
+  end
+
+end
+
+class TestAPITokenMiddleware < MiniTest::Unit::TestCase
+
+  def test_working_token_authenticator
+    LWS.setup do |config|
+      config.api_token = nil
+      config.api_token_middleware = WorkingTokenAuthenticator
+      if ENV["LC_LWS_TEST_DEBUG"].present?
+        config.http_debug = true
+        config.json_debug = true
+      end
+      config.environment = :development
+    end
+
+    task = LWS::Auth::Task.all.first
+    refute_nil(task)
+
+    # Restore the token
+    LWS.config.api_token = ENV["LC_LWS_TEST_TOKEN"]
+    LWS.config.api_token_middleware = nil
+  end
+
+  def test_broken_token_authenticator
+    LWS.setup do |config|
+      config.api_token = nil
+      config.api_token_middleware = BrokenTokenAuthenticator
+      if ENV["LC_LWS_TEST_DEBUG"].present?
+        config.http_debug = true
+        config.json_debug = true
+      end
+      config.environment = :development
+    end
+
+    task = LWS::Auth::Task.all.first
+    assert_nil(task)
+
+    # Restore the token
+    LWS.config.api_token = ENV["LC_LWS_TEST_TOKEN"]
+    LWS.config.api_token_middleware = nil
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lws
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2016-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
-  requirement: &6510360 !ruby/object:Gem::Requirement
+  requirement: &14765880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -24,10 +24,10 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *6510360
+  version_requirements: *14765880
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &6509420 !ruby/object:Gem::Requirement
+  requirement: &14764980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -35,10 +35,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *6509420
+  version_requirements: *14764980
 - !ruby/object:Gem::Dependency
   name: her
-  requirement: &6508740 !ruby/object:Gem::Requirement
+  requirement: &14764260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -46,10 +46,10 @@ dependencies:
         version: 0.8.1
   type: :runtime
   prerelease: false
-  version_requirements: *6508740
+  version_requirements: *14764260
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &6508140 !ruby/object:Gem::Requirement
+  requirement: &14763660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -57,10 +57,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *6508140
+  version_requirements: *14763660
 - !ruby/object:Gem::Dependency
   name: her
-  requirement: &6507420 !ruby/object:Gem::Requirement
+  requirement: &14762960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -68,10 +68,10 @@ dependencies:
         version: 0.8.1
   type: :development
   prerelease: false
-  version_requirements: *6507420
+  version_requirements: *14762960
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &6506840 !ruby/object:Gem::Requirement
+  requirement: &14762380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -79,10 +79,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *6506840
+  version_requirements: *14762380
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &6522620 !ruby/object:Gem::Requirement
+  requirement: &14778140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -90,7 +90,7 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *6522620
+  version_requirements: *14778140
 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."
@@ -113,13 +113,13 @@ files:
 - lib/lws/presence.rb
 - lib/lws/version.rb
 - lws.gemspec
+- test/test_api_token_middleware.rb
 - test/test_auth.rb
 - test/test_caching.rb
 - test/test_generic.rb
 - test/test_helper.rb
 - test/test_maps.rb
 - test/test_presence.rb
-- test/test_proc_token.rb
 homepage: https://leftclick.eu/
 licenses: []
 post_install_message: 
@@ -145,11 +145,11 @@ signing_key:
 specification_version: 3
 summary: LeftClick web services library for Ruby
 test_files:
+- test/test_api_token_middleware.rb
 - test/test_auth.rb
 - test/test_caching.rb
 - test/test_generic.rb
 - test/test_helper.rb
 - test/test_maps.rb
 - test/test_presence.rb
-- test/test_proc_token.rb
 has_rdoc: 

data/test/test_proc_token.rb

@@ -1,35 +0,0 @@
-require "test_helper"
-
-class TestProcToken < MiniTest::Unit::TestCase
-
-  def test_working_proc_token
-    # Redo the LWS setup with a proc block as token
-    LWS.setup do |config|
-      config.api_token = proc { ENV["LC_LWS_TEST_TOKEN"] }
-      if ENV["LC_LWS_TEST_DEBUG"].present?
-        config.http_debug = true
-        config.json_debug = true
-      end
-      config.environment = :development
-    end
-
-    task = LWS::Auth::Task.all.first
-    refute_nil(task)
-  end
-
-  def test_failing_proc
-    # Redo the LWS setup with a proc block as token
-    LWS.setup do |config|
-      config.api_token = proc { nil }
-      if ENV["LC_LWS_TEST_DEBUG"].present?
-        config.http_debug = true
-        config.json_debug = true
-      end
-      config.environment = :development
-    end
-
-    task = LWS::Auth::Task.all.first
-    assert_nil(task)
-  end
-
-end