lws 0.1.7.1 → 0.2.0

data/bin/lwsconsole

@@ -5,6 +5,7 @@
 # Usage: lwsconsole <LWS API token> [<app>:<endpoint> ...]
 
 require "irb"
+require "logger"
 require "lws"
 require "pp"
 
@@ -46,12 +47,22 @@ ARGV.each do |app_endpoint|
   endpoints[app.to_sym] = endpoint
 end
 
+# Set up the logger
+logger = Logger.new($stdout)
+logger.level = Logger::DEBUG
+logger.progname = "LWSConsole"
+logger.formatter = proc do |sev, datetime, progname, msg|
+                     dt_fmt = logger.datetime_format || "%F %X"
+                     "#{datetime.strftime(dt_fmt)} #{progname}(#$$) [#{sev}]: #{msg}\n"
+                   end
+
 # Set up the API
 LWS.setup do |config|
   config.api_token = api_token
+  config.endpoints = endpoints
   config.http_debug = true
   config.json_debug = true
-  config.endpoints = endpoints
+  config.logger = logger
 end
 
 def reload!

data/lib/lws.rb

@@ -20,22 +20,28 @@ module LWS
   # @!visibility private
   class HTTPLogger < Faraday::Response::Middleware
 
+    def initialize(app, logger)
+      raise "cannot log HTTP requests without a logger" if logger.nil?
+      @logger = logger
+      super(app)
+    end
+
     def call(env)
-      puts ">>> #{env[:method].upcase} #{env[:url].to_s}"
+      @logger.debug ">>> #{env[:method].upcase} #{env[:url].to_s}"
       env[:request_headers].each do |hdr, val|
-        puts "    #{hdr}: #{val}"
+        @logger.debug "    #{hdr}: #{val}"
       end
-      puts ">>> #{env[:body] || "nil"}"
+      @logger.debug ">>> #{env[:body] || "nil"}"
       super
     end
 
     def on_complete(env)
       super
-      puts "<<< HTTP #{env[:status].to_s}"
+      @logger.debug "<<< HTTP #{env[:status].to_s}"
       env[:response_headers].each do |hdr, val|
-        puts "    #{hdr}: #{val}"
+        @logger.debug "    #{hdr}: #{val}"
       end
-      puts "<<< #{env[:body] || "nil"}"
+      @logger.debug "<<< #{env[:body] || "nil"}"
     end
 
   end
@@ -43,9 +49,15 @@ module LWS
   # @!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 = MultiJson.dump(env[:body], pretty: true)
-      dump.split("\n").each { |line| puts "||| #{line}" }
+      dump.split("\n").each { |line| @logger.debug "||| #{line}" }
     end
 
   end
@@ -100,6 +112,11 @@ module LWS
     #  @return [Boolean] whether to show HTTP debug messages
     property :http_debug, default: false
 
+    #@!attribute logger
+    #  @return [#fatal, #error, #warn, #info, #debug] the logger object
+    #    (Rails logger, Logger, etc.)
+    property :logger
+
     #@!attribute json_debug
     #  @return [Boolean] whether to show JSON debug messages
     property :json_debug, default: false
@@ -108,11 +125,12 @@ module LWS
   # Sets up the application API libraries using the provided
   # configuration (see {Config}).
   #
-  # @example Set up LWS with a token, an endpoint override and HTTP debugging
+  # @example Set up LWS with a token, an endpoint override, HTTP debugging and the Rails logger
   #   LWS.setup do |config|
   #     config.api_token = "MY_TOKEN"
   #     config.endpoints = { maps: https://maps-dev.leftclick.eu }
   #     config.http_debug = true
+  #     config.logger = Rails.logger
   #   end
   #
   # @yieldparam [Config] config an API configuration object that can be
@@ -150,10 +168,10 @@ module LWS
       c.use Faraday::Request::UrlEncoded
 
       # Response
-      c.use JSONLogger if config.json_debug
+      c.use JSONLogger, config.logger if config.json_debug
       c.use Her::Middleware::DefaultParseJSON
       c.use FaradayMiddleware::FollowRedirects, limit: 3
-      c.use HTTPLogger if config.http_debug
+      c.use HTTPLogger, config.logger if config.http_debug
 
       # Adapter
       c.use Faraday::Adapter::NetHttp

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.7.1'
+  VERSION = '0.2.0'
 
 end

data/test/test_helper.rb

@@ -1,3 +1,4 @@
+require "logger"
 require "lws"
 require "minitest/autorun"
 
@@ -7,6 +8,7 @@ def reconfigure(options = {})
   LWS.setup do |config|
     config.api_token = ENV["LC_LWS_TEST_TOKEN"]
     if ENV["LC_LWS_TEST_DEBUG"].present?
+      config.logger = Logger.new($stdout)
       config.http_debug = true
       config.json_debug = true
     end

data/test/test_logger.rb

@@ -0,0 +1,23 @@
+require "test_helper"
+
+class TestLogger < MiniTest::Unit::TestCase
+
+  def test_working_logger
+    log = StringIO.new
+    logger = Logger.new(log)
+    logger.level = Logger::DEBUG
+
+    # Configure the logger and enable HTTP request and JSON data debugging
+    reconfigure(logger: logger,
+                http_debug: true,
+                json_debug: true)
+
+    # Perform a query to have any log entries
+    LWS::Auth::Task.all.first
+    refute_nil(log.string)
+
+    # Restore the token
+    reconfigure
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lws
 version: !ruby/object:Gem::Version
-  version: 0.1.7.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-27 00:00:00.000000000 Z
+date: 2016-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
-  requirement: &10637080 !ruby/object:Gem::Requirement
+  requirement: &6049580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -24,10 +24,10 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *10637080
+  version_requirements: *6049580
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &10636140 !ruby/object:Gem::Requirement
+  requirement: &6048680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -35,10 +35,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *10636140
+  version_requirements: *6048680
 - !ruby/object:Gem::Dependency
   name: her
-  requirement: &10635460 !ruby/object:Gem::Requirement
+  requirement: &6047960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -46,10 +46,10 @@ dependencies:
         version: 0.8.1
   type: :runtime
   prerelease: false
-  version_requirements: *10635460
+  version_requirements: *6047960
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &10634860 !ruby/object:Gem::Requirement
+  requirement: &6047360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -57,10 +57,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *10634860
+  version_requirements: *6047360
 - !ruby/object:Gem::Dependency
   name: her
-  requirement: &10634140 !ruby/object:Gem::Requirement
+  requirement: &6046660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -68,10 +68,10 @@ dependencies:
         version: 0.8.1
   type: :development
   prerelease: false
-  version_requirements: *10634140
+  version_requirements: *6046660
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &10633560 !ruby/object:Gem::Requirement
+  requirement: &6046080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -79,10 +79,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *10633560
+  version_requirements: *6046080
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &10649340 !ruby/object:Gem::Requirement
+  requirement: &6061840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -90,7 +90,7 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *10649340
+  version_requirements: *6061840
 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."
@@ -118,6 +118,7 @@ files:
 - test/test_caching.rb
 - test/test_generic.rb
 - test/test_helper.rb
+- test/test_logger.rb
 - test/test_maps.rb
 - test/test_presence.rb
 homepage: https://leftclick.eu/
@@ -150,6 +151,7 @@ test_files:
 - test/test_caching.rb
 - test/test_generic.rb
 - test/test_helper.rb
+- test/test_logger.rb
 - test/test_maps.rb
 - test/test_presence.rb
 has_rdoc: