lws 6.1.0.beta2 → 6.1.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a09ba1c573d34f7640da8aad3df199382741d49
-  data.tar.gz: 3bc4b060e98e70810ab6f8d503e15e61e0d85cf7
+  metadata.gz: 7ce4acf9c7e03325ea30484df6033d9629e5b529
+  data.tar.gz: f389cb4a66d55a2ac983009e14b8ae78e8f5429e
 SHA512:
-  metadata.gz: 4e91fef268389561a3414fecaaaf914f38f85b84dbe41ad46bd8c2a9da54ad1eb40f158be4b39929f6c083045c729d47828669485cedebf0fe15407bdad48487
-  data.tar.gz: e1ae441078003a07e879e2df01d50a921f1708530dda407100e6a1bc92607854f321ed87d8e705495a507b7d38e0882c8b15f84eed5909d7ec6435b0ccd66ea8
+  metadata.gz: cda7314094b11b9f564c360ab04f358f5fad616004d81159caabdf072421d472053240523068d4c1c8692be1d108121807d343197d61acec0fdfc25bea9f7bfb
+  data.tar.gz: fda0ae24f5cd2383bcddda99555321a68d118e6bee0cc19694ee96ec6dafe28175f6032299e9e3b1680c7f28b2c2dd1c4d528c868df57327deddf7ff268212da

data/README.rdoc

@@ -23,9 +23,9 @@ would create a new +config/initializers/lws.rb+ file with these lines:
     config.api_token = "…" # Get it from someplace
   end
 
-After that, due to the fact that LWS is based on Her, you can access the
-objects in the LeftClick Web Services similary to many ActiveRecord-like
-ORM's:
+After that, due to the fact that LWS is based on
+[Spyke](https://github.com/balvig/spyke), you can access the objects in the
+LeftClick Web Services similary to many ActiveRecord-like ORM's:
 
   map = Maps::Map.all.first
   markers = map.markers
@@ -72,4 +72,4 @@ runtime determined API token as value, for example:
 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 not a custom API token middleware is used.
+This only works if a custom API token middleware is not used.

data/lib/lws.rb

@@ -16,6 +16,7 @@ require "spyke"
 require "pp"
 require "webmock"
 
+require "lws/middleware"
 require "lws/stubbing"
 require "lws/version"
 
@@ -29,97 +30,13 @@ WebMock.disable!
 # libraries.
 module LWS
 
+  include Middleware
+
   # The list of supported apps (web service libraries) loaded by
   # {.setup}.
   SUPPORTED_APPS = [:generic, :auth, :corporate_website, :digital_signage,
                     :maps, :presence, :ticket]
 
-  # @private
-  # @!visibility private
-  class JSONParser < Faraday::Response::Middleware
-    def parse(body)
-      data = MultiJson.load(body, symbolize_keys: true)
-      metadata = data.delete(:metadata)
-      errors = data.delete(:errors)
-
-      # If there are errors, discard the data.
-      data = nil if errors.present?
-
-      { data: data,
-        metadata: metadata,
-        errors: errors }
-    end
-  end
-
-  # @private
-  # @!visibility private
-  class HTTPLogger < Faraday::Response::Middleware
-
-    def initialize(app, logger, show_headers)
-      raise "cannot log HTTP requests without a logger" if logger.nil?
-      @logger = logger
-      @show_headers = show_headers
-      super(app)
-    end
-
-    def call(env)
-      @logger.debug ">>> #{env[:method].upcase} #{env[:url].to_s}"
-      if @show_headers
-        env[:request_headers].each do |hdr, val|
-          @logger.debug "    #{hdr}: #{val}"
-        end
-      end
-      @logger.debug ">>> #{env[:body] || "nil"}"
-      super
-    end
-
-    def on_complete(env)
-      super
-      @logger.debug "<<< HTTP #{env[:status].to_s}"
-      if @show_headers
-        env[:response_headers].each do |hdr, val|
-          @logger.debug "    #{hdr}: #{val}"
-        end
-      end
-      @logger.debug "<<< #{env[:body] || "nil"}"
-    end
-
-  end
-
-  # @private
-  # @!visibility private
-  class JSONLogger < Faraday::Response::Middleware
-
-    def initialize(app, logger)
-      raise "cannot log JSON data without a logger" if logger.nil?
-      @logger = logger
-      super(app)
-    end
-
-    def on_complete(env)
-      dump = JSON.pretty_generate(env[:body])
-      dump.split("\n").each { |line| @logger.debug "||| #{line}" }
-    end
-
-  end
-
-  # @private
-  # @!visibility private
-  class RequestHeaders < Faraday::Middleware
-
-    def initialize(app, token)
-      super(app)
-      @token = token
-    end
-
-    def call(env)
-      env[:request_headers]["X-Token"] = @token if @token
-      env[:request_headers]["Accept"] = "application/json"
-      @app.call(env)
-    end
-
-  end
-
   # @return [Config] the API configuration for the web services
   mattr_reader :config
 
@@ -267,7 +184,7 @@ module LWS
     @app_modules = {}
     app_module_path = File.dirname(__FILE__)
     SUPPORTED_APPS.each do |app_name|
-      load "#{app_module_path}/lws/#{app_name}.rb"
+      load "#{app_module_path}/lws/apps/#{app_name}.rb"
       @app_modules[app_name] = LWS.const_get(app_name.to_s.camelize)
     end
   end

data/lib/lws/middleware.rb

@@ -0,0 +1,15 @@
+#
+# 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 "lws/middleware/http_logger"
+require "lws/middleware/json_logger"
+require "lws/middleware/json_parser"
+require "lws/middleware/request_headers"

data/lib/lws/middleware/http_logger.rb

@@ -0,0 +1,53 @@
+#
+# 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
+
+  module Middleware
+
+    # @private
+    # @!visibility private
+    class HTTPLogger < Faraday::Response::Middleware
+
+      def initialize(app, logger, show_headers)
+        raise "cannot log HTTP requests without a logger" if logger.nil?
+        @logger = logger
+        @show_headers = show_headers
+        super(app)
+      end
+
+      def call(env)
+        @logger.debug ">>> #{env[:method].upcase} #{env[:url].to_s}"
+        if @show_headers
+          env[:request_headers].each do |hdr, val|
+            @logger.debug "    #{hdr}: #{val}"
+          end
+        end
+        @logger.debug ">>> #{env[:body] || "nil"}"
+        super
+      end
+
+      def on_complete(env)
+        super
+        @logger.debug "<<< HTTP #{env[:status].to_s}"
+        if @show_headers
+          env[:response_headers].each do |hdr, val|
+            @logger.debug "    #{hdr}: #{val}"
+          end
+        end
+        @logger.debug "<<< #{env[:body] || "nil"}"
+      end
+
+    end
+   
+  end
+
+end

data/lib/lws/middleware/json_logger.rb

@@ -0,0 +1,36 @@
+#
+# 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
+
+  module Middleware
+
+    # @private
+    # @!visibility private
+    class JSONLogger < Faraday::Response::Middleware
+
+      def initialize(app, logger)
+        raise "cannot log JSON data without a logger" if logger.nil?
+        @logger = logger
+        super(app)
+      end
+
+      def on_complete(env)
+        return if env[:body].blank?
+        dump = JSON.pretty_generate(env[:body])
+        dump.split("\n").each { |line| @logger.debug "||| #{line}" }
+      end
+
+    end
+
+  end
+
+end

data/lib/lws/middleware/json_parser.rb

@@ -0,0 +1,46 @@
+#
+# 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
+
+  module Middleware
+
+    # @private
+    # @!visibility private
+    class JSONParser < Faraday::Response::Middleware
+
+      def parse(body)
+        data = MultiJson.load(body, symbolize_keys: true)
+        metadata = data.delete(:metadata)
+        errors = data.delete(:errors)
+
+        # If there are errors, discard the data.
+        data = nil if errors.present?
+
+        { data: data,
+          metadata: metadata,
+          errors: errors }
+      end
+
+      def on_complete(env)
+        env[:body] = case env[:status]
+                     when 204, 304
+                       parse('{}')
+                     else
+                       parse(env[:body])
+                     end
+      end
+
+    end
+
+  end
+
+end

data/lib/lws/middleware/request_headers.rb

@@ -0,0 +1,35 @@
+#
+# 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
+ 
+  module Middleware
+
+    # @private
+    # @!visibility private
+    class RequestHeaders < Faraday::Middleware
+
+      def initialize(app, token)
+        super(app)
+        @token = token
+      end
+
+      def call(env)
+        env[:request_headers]["X-Token"] = @token if @token
+        env[:request_headers]["Accept"] = "application/json"
+        @app.call(env)
+      end
+
+    end
+
+  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.0.beta2'
+  VERSION = '6.1.0.beta3'
 
 end

data/test/auth_test.rb

@@ -156,7 +156,7 @@ class TestAuthToken < MiniTest::Test
   end
 
   def test_valid_associations
-    refute_nil(@token.account)
+    assert_instance_of(Account, @token.account)
     if @token.user.present?
       assert_instance_of(User, @token.user)
       assert_equal(@token.user.account.id, @token.account.id)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lws
 version: !ruby/object:Gem::Version
-  version: 6.1.0.beta2
+  version: 6.1.0.beta3
 platform: ruby
 authors:
 - LeftClick B.V.
@@ -236,14 +236,19 @@ files:
 - bin/lwsconsole
 - copyright.txt
 - lib/lws.rb
-- lib/lws/auth.rb
-- lib/lws/corporate_website.rb
-- lib/lws/digital_signage.rb
-- lib/lws/generic.rb
-- lib/lws/maps.rb
-- lib/lws/presence.rb
+- lib/lws/apps/auth.rb
+- lib/lws/apps/corporate_website.rb
+- lib/lws/apps/digital_signage.rb
+- lib/lws/apps/generic.rb
+- lib/lws/apps/maps.rb
+- lib/lws/apps/presence.rb
+- lib/lws/apps/ticket.rb
+- lib/lws/middleware.rb
+- lib/lws/middleware/http_logger.rb
+- lib/lws/middleware/json_logger.rb
+- lib/lws/middleware/json_parser.rb
+- lib/lws/middleware/request_headers.rb
 - lib/lws/stubbing.rb
-- lib/lws/ticket.rb
 - lib/lws/version.rb
 - lws.gemspec
 - test/api_token_middleware_test.rb