lws 6.1.0.beta3 → 6.1.0.beta4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ce4acf9c7e03325ea30484df6033d9629e5b529
-  data.tar.gz: f389cb4a66d55a2ac983009e14b8ae78e8f5429e
+  metadata.gz: 5b58d4f19b39cd31f8eb39c19252248889bbcdc1
+  data.tar.gz: fe5430ca9566e47fce0585eb7dc5e9f3e06d1406
 SHA512:
-  metadata.gz: cda7314094b11b9f564c360ab04f358f5fad616004d81159caabdf072421d472053240523068d4c1c8692be1d108121807d343197d61acec0fdfc25bea9f7bfb
-  data.tar.gz: fda0ae24f5cd2383bcddda99555321a68d118e6bee0cc19694ee96ec6dafe28175f6032299e9e3b1680c7f28b2c2dd1c4d528c868df57327deddf7ff268212da
+  metadata.gz: a9b8964fe328533bd15bcc54aaa2e9f44239bafd204f00b56fbfc9e8ecc0050fecf14a1d6c4363f432d06074267e80689f4f40465ffa5be8ffdd8040a355cc39
+  data.tar.gz: 4f8664f672916043a6aac86cb7175f7e001c4df14537e0b2c345bd6f03306610184519afe7dc5ab5ca4f309eee8aca62c3f6a55b068f6c465e46b9063fde0009

data/bin/lwsconsole

@@ -2,23 +2,59 @@
 #
 # lwsconsole - A command-line tool to access the LWS web services
 #
-# Usage: lwsconsole <LWS API token> [<app>:<endpoint> ...]
+# Usage: lwsconsole [<option>...] [<app>:<endpoint>...]
 
 require "logger"
 require "lws"
+require "optparse"
 require "pp"
 require "pry"
 
 # Parse the command-line arguments
-if ARGV.length < 1
-  puts "Usage: #{$0} <LWS API token> [<app>:<endpoint> ...]"
-  exit 1
+PROG_NAME = File.basename($0)
+@options = {}
+opt_parser = OptionParser.new do |opts|
+  opts.banner = <<EOB
+Usage: #{PROG_NAME} [OPTION]... [APP]:[ENDPOINT]...
+A command-line tool to access the LWS web services.
+
+EOB
+
+  opts.separator("Optional arguments:")
+  opts.on("-a", "--app=APP-NAME", "switch to a specific app") do |app|
+    @options[:app] = app
+  end
+  opts.on("-d", "--[no-]debug", "show HTTP and JSON debug information") do |debug|
+    @options[:debug] = debug
+  end
+  opts.on("-e", "--environment=ENV", "select the LWS environment (default: production)") do |env|
+    @options[:environment] = env.to_sym
+  end
+  opts.on("-t", "--token=TOKEN", "the LWS API token necessary to gain access") do |token|
+    @options[:token] = token
+  end
+  opts.on("--help", "display this help and exit") do
+    puts opts
+    exit
+  end
+  opts.on("--version", "display the LWS library version and exit") do
+    puts LWS::VERSION
+    exit
+  end
+end
+
+begin
+  opt_parser.parse!
+rescue OptionParser::ParseError => e
+  puts "#{PROG_NAME}: #{e}"
+  puts opt_parser
+  exit 2
 end
-api_token = ARGV.shift
-endpoints = {}
+
+@endpoints = {}
 ARGV.each do |app_endpoint|
   app,endpoint = app_endpoint.split(':', 2)
-  endpoints[app.to_sym] = endpoint
+  @endpoints[app.to_sym] = endpoint
 end
 
 # Set up the logger
@@ -32,12 +68,22 @@ logger.formatter =
   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.logger = logger
+begin
+  LWS.setup do |config|
+    config.api_token = @options[:token] if @options[:token]
+    config.environment = @options[:environment] if @options[:environment]
+    config.endpoints = @endpoints
+    config.http_debug = @options[:debug]
+    config.json_debug = @options[:debug]
+    config.logger = logger
+  end
+  if @options[:app]
+    @app_module = LWS.app_module(@options[:app].downcase)
+    puts "#{PROG_NAME}: Cannot find app `#{@options[:app]}', ignoring it!" unless @app_module
+  end
+rescue => e
+  puts "#{PROG_NAME}: Problem during LWS setup: #{e}"
+  exit 3
 end
 
 ### Extra commands/methods
@@ -68,5 +114,5 @@ def reload!
   LWS.load_app_modules
 end
 
-# Use the LWS module as the default namespace
-LWS.pry
+# Use the LWS module or the selected app module as the default namespace
+(@app_module || LWS).pry

data/lib/lws/config.rb

@@ -0,0 +1,69 @@
+#
+# 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
+
+  # = The LWS API configuration class
+  #
+  # This class represents the configuration that is used for connecting to
+  # LWS.
+  #
+  # @note Either the API token or API token middleware needs to be
+  #   configured for the library to work properly!
+  class Config < Hashie::Dash
+    #@!attribute api_token
+    #  @return [String, nil] the API token necessary to gain access
+    property :api_token
+
+    #@!attribute api_token_middleware
+    # @return [Faraday::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
+
+    #@!attribute endpoints
+    #  @return [Hash{Symbol=>String}] a mapping of application endpoint
+    #    overrides (default: +{}+)
+    property :endpoints, default: {}
+
+    #@!attribute environment
+    #  @return [Symbol] the (default) API environment
+    #     (default: +:production+)
+    property :environment, default: :production
+
+    #@!attribute http_debug
+    #  @return [Boolean] whether to show HTTP debug messages (default: +false+)
+    property :http_debug, default: false
+
+    #@!attribute http_debug_headers
+    #  @return [Boolean] whether to show HTTP headers in the debug messages
+    #    (default: +false+)
+    property :http_debug_headers, default: false
+
+    #@!attribute json_debug
+    #  @return [Boolean] whether to show JSON debug messages (default: +false+)
+    property :json_debug, default: false
+
+    #@!attribute logger
+    #  @return [#fatal, #error, #warn, #info, #debug] the logger object
+    #    (Rails logger, Logger, etc.)
+    property :logger
+
+    #@!attribute stubbing
+    #  @return [String] the path to a directory with stubbing fixtures
+    #    (setting this enables the default stubs)
+    property :stubbing
+  end
+
+end

data/lib/lws/middleware.rb

@@ -9,6 +9,15 @@
 # Netherlands, info@leftclick.eu, +31492-782120.
 
 
+module LWS
+
+  # @private
+  # @!visibility private
+  module Middleware
+  end
+
+end
+
 require "lws/middleware/http_logger"
 require "lws/middleware/json_logger"
 require "lws/middleware/json_parser"

data/lib/lws/stubbing.rb

@@ -11,19 +11,23 @@
 
 module LWS
 
-  # = Class that regulates request stubbing based on a tree of fixtures
+  # = The LWS API stubbing class
   #
-  # Stubbing is enabled when a path is provided to a tree of fixture objects.
-  # These fixture files should have the form:
+  # This class regulates request stubbing based on a tree of fixtures.
+  # It can be used for testing an application that uses this library.
   #
-  # app_name:
-  #   /model/1:
-  #     default:
-  #       id: 1
-  #       attr: value
-  #     test:
-  #       id: 1
-  #       attr: other_value
+  #
+  # These fixtures are defined in files that should have the following
+  # form:
+  #
+  #   app_name:
+  #     /model/1:
+  #       default:
+  #         id: 1
+  #         attr: value
+  #       test:
+  #         id: 1
+  #         attr: other_value
   #
   # When initialized, for all apps, for all paths, the default stub is
   # loaded if it exists.
@@ -72,6 +76,7 @@ module LWS
     # Disables all request stubbing.
     #
     # This should be used when the stubbing is not used anymore.
+    # @return [void]
     def disable!
       WebMock.disable!
     end
@@ -82,13 +87,14 @@ module LWS
     # @note For the HTTP method +:delete+, the response status is set to 204.
     #
     # @param method [Symbol] the HTTP method (+:get+, +:put+, etc.)
-    # @param app_name [Symbol] the app name (see {::SUPPORTED_APPS})
+    # @param app_name [Symbol] the app name (see {LWS::SUPPORTED_APPS})
     # @param path [String] the path part of the request URI
     # @param fixture_name [Symbol, nil] the name of the fixture to use as stub
     #   response body (or +nil+ for an empty fixture)
     # @param http_status [Fixnum] the HTTP status code to use
     # @raise if the fixture name could not be found for the given app name
     #   and path
+    # @return [void]
     def replace(method, app_name, path, fixture_name = :default, http_status = 200)
       fixture = if fixture_name
                   @fixtures.dig(app_name.to_s, path, fixture_name.to_s)
@@ -123,6 +129,7 @@ module LWS
     # @param path [String] the path part of the request URI
     # @raise if there is not request stub for the given HTTP method,
     #   app name and path
+    # @return [void]
     def remove(method, app_name, path)
       request_stub = @stubs.delete([method, app_name, path])
       raise "no such request stub" unless request_stub

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.beta3'
+  VERSION = '6.1.0.beta4'
 
 end

data/lib/lws.rb

@@ -16,6 +16,7 @@ require "spyke"
 require "pp"
 require "webmock"
 
+require "lws/config"
 require "lws/middleware"
 require "lws/stubbing"
 require "lws/version"
@@ -43,56 +44,6 @@ module LWS
   # @return [Stubbing] the stubbing setup for the web service
   mattr_reader :stubbing
 
-  # = The API configuration class
-  #
-  # @note Either the API token or API token middleware needs to be
-  #   configured for LWS to work properly!
-  class Config < Hashie::Dash
-    #@!attribute api_token
-    #  @return [String, nil] the API token necessary to gain access
-    property :api_token
-
-    #@!attribute api_token_middleware
-    # @return [Faraday::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
-
-    #@!attribute endpoints
-    #  @return [Hash{Symbol=>String}] a mapping of application endpoint
-    #    overrides
-    property :endpoints, default: {}
-
-    #@!attribute environment
-    #  @return [Symbol] the (default) API environment
-    property :environment, default: :production
-
-    #@!attribute http_debug
-    #  @return [Boolean] whether to show HTTP debug messages
-    property :http_debug, default: false
-
-    #@!attribute http_debug_headers
-    #  @return [Boolean] whether to show HTTP headers in the debug messages
-    property :http_debug_headers, default: false
-
-    #@!attribute json_debug
-    #  @return [Boolean] whether to show JSON debug messages
-    property :json_debug, default: false
-
-    #@!attribute logger
-    #  @return [#fatal, #error, #warn, #info, #debug] the logger object
-    #    (Rails logger, Logger, etc.)
-    property :logger
-
-    #@!attribute stubbing
-    #  @return [String] the path to a directory with stubbing fixtures
-    #    (setting this enables the default stubs)
-    property :stubbing
-  end
-
   # Sets up the application API libraries using the provided
   # configuration (see {Config}).
   #
@@ -104,9 +55,9 @@ module LWS
   #     config.logger = Rails.logger
   #   end
   #
-  # A default value for the API token can be set using the
-  # +LC_LWS_API_TOKEN+ environment variable.  The default environment can
-  # be overriden using the +LC_LWS_ENV+ environment variable.
+  # The API token can be overridden using the +LC_LWS_API_TOKEN+
+  # environment variable.  The LWS environment can be overriden using the
+  # +LC_LWS_ENV+ environment variable.
   #
   # @yieldparam [Config] config an API configuration object that can be
   #   configured

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lws
 version: !ruby/object:Gem::Version
-  version: 6.1.0.beta3
+  version: 6.1.0.beta4
 platform: ruby
 authors:
 - LeftClick B.V.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-03 00:00:00.000000000 Z
+date: 2018-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
@@ -243,6 +243,7 @@ files:
 - lib/lws/apps/maps.rb
 - lib/lws/apps/presence.rb
 - lib/lws/apps/ticket.rb
+- lib/lws/config.rb
 - lib/lws/middleware.rb
 - lib/lws/middleware/http_logger.rb
 - lib/lws/middleware/json_logger.rb